Template repo

[hectorsector]

Tasks

• [x] Decide on template code base: @ppremk (12/5)
• [x] Create template repository: @ppremk (12/6)

Since we're using a link checker, image checker, and test driven development, perhaps we can showcase a documentation project? We could create PRs to introduce content, but also PRs to improve the documentation product itself. Just a suggestion.

[hollenberry]

👋 @hectorsector / @carolynshin I don't know that I'd be the best for this task since we switched topics.

Happy to provide some feedback on the end result!

[carolynshin]

@ppremk 👋 - I believe your are the PRP for this issue. I added two tasks above in the OP! Let me know if you feel OK with the timeline.

[ppremk]

@carolynshin 👋 The dates are good. Infact I had already begun some work on it and created the following repo:

https://github.com/githubtraining/ci-docs-project-template

At this point it is still WIP since I could not get the docsify to work on the GH Pages. @hectorsector are you ok with this repo? Its a trimmed down version of our training manual. The content for the sidebar and the md files will be updated as we go along.

[hectorsector]

@ppremk Just the Docs is another tool that also works with GitHub Pages. There was some prior conversation about this tool in comparison to Just the Docs. Ultimately, I think I'd be happy with either one, as long as we can deploy it via CI and as long as we can integrate it with html-proofer or something like it.

In the case of Docsify, do we get an HTML against which to run html-proofer? Or perhaps we should use a different tool for checking links/images?

[carolynshin]

👋 Hello @ppremk + @hectorsector ! Checking in here to see if there are any issues completing this and closing this by Dec 7th?

[ppremk]

@carolynshin this task is completed as per the planned date 👍We can proceed to close this

Some notes on the setup of the template repo as follows:

Project Repo:

• https://github.com/githubtraining/ci-docs-project-template

Project Output:

• This is a documentation manual which renders the docsify UI along with a coverpage and sidebar which uses Markdownfile
• This is the core of the project
• It uses the .nojekyll file and is hosted in GitHub Pages

Project Structure and Addons:

• Gemfile, Gemfile.lock and Rakefile were added to enable HTMLproofer to be installed and also for having some test automation which checks specifically for one HTML file (converted from Markdown) on a test criteria
• The test criteria is "testing for a broken external hyperlink"
• The scripts/test.rb file contains steps required as a helper to support the Rakefile logic when executed
• .circleci/config.yml file was added to support CI to the template
• Branch protection rule was configure to ensure that the master branch is protected and PR's can only be merge upon passing CI build status
• The config.yml file uses the docker container: circleci/ruby:2.4.1-node-browsers

The template was tested and the .circleci build status can be viewed from here:

• https://circleci.com/gh/githubtraining/ci-docs-project-template

PS: @githubtraining/trainers should have access. Please let me know if there is issues accessing it