-
Notifications
You must be signed in to change notification settings - Fork 236
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DO NOT MERGE: Split documentation in to sub-app #158
Conversation
…kit into split-docs-app
useAuth = process.env.USE_AUTH || config.useAuth; | ||
useAuth = process.env.USE_AUTH || config.useAuth, | ||
useDocs = (config.useDocs == "true" ) ? true : false, | ||
promoMode = process.env.PROMO_MODE || 'false', |
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 should get converted to lowercase like the other environment booleans
I think I've addressed all your comments except caching of the url. |
@joelanman I've implemented caching of the url for the life of the app. This is probably fine as long as the app goes to sleep every so often. If we ever have persistently running apps, we may want to do something a bit more clever. |
f754023
to
20abd2c
Compare
<li><a href="/docs">GOV.UK prototype kit</a></li> | ||
</ol> | ||
</div> | ||
<h1 class="heading-xlarge">About</h1> |
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.
'About the prototype kit'?
Can this be closed in favour of #244? @edwardhorsford |
This PR moves documentation and examples outside of
app
and in to a new sub-app calleddocs
. This gives us a more consistent place to put documentation, and means our upgrade path is easier - users upgrading via copyingapp
will now be able to get up to date documentation.This PR also introduces a new documentation 'home' - the intention being we can push this to heroku and have a single place we can point people at to get the kit and docs, etc.
You can play with it here: http://prototype-kit-documentation.herokuapp.com/
Fixes #151
Changes:
/docs/
docs
- this means we can deploy to govuk-prototype-kit.herokuapp.com and have the docs be the primary page.nunjucks
fromexpress-nunjucks
, as it didn't seem to correctly support sub-applications.Things that aren't finished:
NB: I'd expect this to be a major version change.