25 make a new step by step guide for new users of the template #39
Conversation
…rs-of-the-template
README.md
Outdated
| # Setup | ||
|
|
||
| 1. Start by [creating a documentation repository in your project, from this template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template), including only the main branch. | ||
| 3. Configure a [publishing source for GitHub Pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages). The documentation site is now live! |
There was a problem hiding this comment.
Is it clear for the noob what to do in the actual repro. It's seems simple from reading the guide but have the steps been tested and verified when performing on a new repro created from the OS2 documentation template?
README.md
Outdated
|
|
||
| 1. Start by [creating a documentation repository in your project, from this template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template), including only the main branch. | ||
| 3. Configure a [publishing source for GitHub Pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages). The documentation site is now live! | ||
| 4. Edit and create `.md` [Markdown files](https://guides.github.com/features/mastering-markdown/) to add more content pages to your docs. |
There was a problem hiding this comment.
For this to be clear the template must contain the bare minimum of .md files to be filled in. Else my fear is that no additional files are created.
There was a problem hiding this comment.
I suggest we define a minimum set of files (e.g. "how_to_deploy") and reference these files to Foundation for Public code governance.
There was a problem hiding this comment.
- document code objectives
- document the code
- Document codebase maturity
maybe 4. (not in FPC) Document deployments methods
The README is now heavily templated with purple text both representing the template text to be removed AND text that explains the expected input into the template In the top of the README is now a quick start guide, that needs to be removed, after completed.
|
@zorp the README template has been restructured to include a step by step guide in the top. The idea is to offer the standard setup instructions inside the README template to make it fast and simple to get started: Any comments before i merge? |
zorp
deleted the
25-make-a-new-step-by-step-guide-for-new-users-of-the-template
branch
Complete rewrite to make it easier to get started with the template.
The guide is now divided into a Maintainer and a Contributor part.