-
Notifications
You must be signed in to change notification settings - Fork 19
[Needs Review] Auto Generated Swagger docs and new docs site on Github Pages #404
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is really great step forward Dara, good job! I really like docsify, and also great there will be a ghpages for Udaru. I think we need to work on the documentation itself, and also on the swagger output, it doesn't really suit a static site (e.g. removing the 'Try it out' buttons), but overall this gives us a really solid foundation to make those changes from here.
docs/_sidebar.md
Outdated
@@ -0,0 +1,11 @@ | |||
- Guides | |||
- [Udaru Overview](overview.md) | |||
- [Authorization Introduction](authorization-introduction.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This can be removed. This file has been replaced by overview.md
and I forgot to remove it in my last PR. Note PR to remove it here: #405
docs/index.html
Outdated
<html lang="en"> | ||
<head> | ||
<meta charset="UTF-8"> | ||
<title>udaru - A policy based authorization module</title> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please change to 'Udaru - the Platform Authorization Service'
@dberesford I fully agree. The content of the docs really needs to be improved. I think before it was hard to know even where to begin but the little docsify site really helps us visualise the docs and gives us some structure to help make those decisions. Now we're in a great place to start improving. I've made your changes as requested. |
This PR does a number of things,
docs/udaru-swagger-site
is checked into source control. So the site generated by the newly addednpm run swagger-gen
is now saved in the repo.A new script -
scripts/deploy-gh-pages.sh
This script is run during a travis build. It regenerates the swagger docs and if there are any changes, they are committed and pushed to master.Some changes in the
.travis.yml
file to run the new script. This new config takes advantage of a new feature in travis called build stages. This allows us to run that publish script once only after the two separate builds for node 6 and node 7 are run.Proposed Docs site - darahayes.github.io/udaru. Github Pages allows us host a docs site within the
docs
folder of the master branch. We already have adocs
folder in the Udaru repo so I used a tool called docsify to turn our docs folder into that docs site in the link.docsify some really nice features:
docs/index.html
file included in this PR.docs/_sidebar.md
And btw you can go into the demo website here darahayes.github.io/udaru and then click the link in the sidebar to get the Swagger Docs.
I know there's going to be a big overhaul with the docs but I think this could really help.
Please let me know what you think.