Write docs #113
Write docs #113
Conversation
✅ Result of Pytest Coverage---------- coverage: platform linux, python 3.9.13-final-0 -----------
|
|
@johnpeart can you |
Yes I do! Cool that it runs both at once! |
|
Just realised I didn't add a 404 page. Easy to fix, will commit directly to this branch (it won't affect what you've done). |
jonodrew
force-pushed
the
write-docs
branch
2 times, most recently
from
9fe7523 to
2f009ca
Compare
|
@johnpeart can you please look over the documentation and tell me what you think? Also add the privacy and cookies stuff, if you like |
|
Not entirely sure why, but on the Cookies page from :5001, the change we previously made seems to have disappeared! |
|
Looks good. I've made a few changes – mostly just to make it a bit more assertive in places (as a bit of a software noob, I always find the more explicit the docs are and the plainer the English, the better!). I've also moved the other docs across as discussed. I've also added a 'Contributing' and 'Licences' page. I assume you want to release this under the Open Government Licence v3.0? That's what GOV.UK uses and it's what we've used on other stuff we produce. We'll need to redirect "/cookies" and "/privacy" from Redis to Jekyll. |
Yup, it's produced mostly on work time.
Almost! We'll need to do a Would you mind also then adding something to CHANGELOG.md, detailing the changes? Under a new heading, 2.6.0 |
|
The last commit (ff5c1fe) should (I hope!) fix the routing.
I suggest we handle this through links added to the header and footer. Can I suggest we create a separate branch for this, that encompasses fixing all the navigation? |
|
Aside from the docs you need to add to, I think my work on this branch is done! |
This adds documentation for installing, building, and running the service locally
This adds content about notifications, how long the content is kept, and how to alter that
The template already existed from the main site, so can just add straight in!
Developers can now run `docker-compose up` to run the docs locally, and on the same system. To run only the docs, don't forget to expose the port `-p 4000:4000` and mount the volume `-v /docs:/srv/jekyll`
For some reason the Gemfile in `/docs` was empty and preventing the build `docker-compose build` command from completing successfully.
I’ve added some information to the landing page of the docs to explain what they are and how to contribute.
Suggested changes to ‘Getting started’ to make the modal verbs a bit more forceful.
Suggested edits to make this a bit more directive. I’ve also amended the link to the repository so that it is more obvious to a screen reader where the link goes.
Add a contributing page and link to it from the “Getting started” page.
Can’t think of a better name for this at the moment!
To be updated
Include link to roadmap
@jonodrew can you check this specifically please?
These pages used to live in the app; now they live in the docs.
@jonodrew I’ve amended the licence file in the docs to link to the OGL licence I’ve also removed the MIT licence from the LICENCE file in the root folder and replaced with the OGL licence.
This reverts commit cfe692e.
Once this is completed, users will be able to read how to download and run this software locally. They'll also be aware of all of the technical things I can think of.