This is the template repository for documentation projects used in the Digital Medicines portfolio. It is designed primarily for use in developing specifications, but is suitable for other documentation types.
To create a new project from the template we're going to clone the template repository, remove all its history and then set up a new repository using the same files:
- Create a new empty repository on Github to hold the new documentation.
- Go to https://github.com/NHSEPS
- Click on New repository and set name & description to sensible values - we'll assume it's called
new-spec-repositoryhere
- Clone the template repository to a local directory, with minimal history.
git clone --depth 1 https://github.com/NHSEPS/documentation-template.git new-spec-repository- Delete the .git directory which holds history and initialize a new repository with no history before adding & committing files to the new repository.
cd new-spec-repository
rm -rf .git
git init
git add .
git commit -m "Initial commit on new documentation"- Tell git where to push and fetch files to, then push them
git remote add origin https://github.com/NHSEPS/new-spec-repository.git
git push -u origin master- Done
To build the documentation locally
- Install Ruby
- Install Jekyll
- Navigate to your project directory and run:
bundle install - Now run Jekyll:
bundle exec jekyll serve - Browse website Browser:
http://localhost:4005
-
Fix warnings related to SSL certificate checking (by configuring the SSL_CERT_FILE env variable) by following instructions to download and reference a cacert.pem file.
-
Fix warnings related to the Jekyll GitHub Metadata plugin, by configuring the JEKYLL_GITHUB_TOKEN environment variable.
TODO
Often for more formal documentation like specifications formal review cycles may be required.
The Github issue tracker can be used to track comments and issues on the documentation.