Readme template #99
Merged
Readme template #99
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…creating new project rather than reading from the code.
jen-machin
approved these changes
Dec 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Brief overview of changes
Updating the template README content and changing the README template text to sit it it's own a .md file.
Why are these changes being made?
So that the README template matches the updated Analysts' Guide information and so that the README_template can be directly linked to from Analysts' Guide and for us to be able to send to teams if they have questions about what should be included.
Detailed description of changes
Removing README text from within the create_projects.R and adding a README_template.md instead.
Amending README_template to include the elements that will now be in the analysts guide.
Additional information for reviewers
Links to this PR for Analyst's Guide: dfe-analytical-services/analysts-guide#123
After this is merged in, I will then link directly to the README_template in the Analysts' Guide.
Issue ticket number/s and link
(dfe-analytical-services/analysts-guide#108)