-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
[WIP] Autogenerated documentation site #274
Conversation
Thank you for your contribution. I've just checked and your commit doesn't appear to be signed-off. |
|
Hi John, the template for this looks really good and it's really useful to have the Travis instructions or building the site, too. I'm thinking of the documentation sitting in its own repository so it is self-contained. I'm not sure if I've seen the roadmap etc brought into a docs site. I'll check what Docker and Kubernetes are doing who I know are an inspiration for our project. |
@alexellis I've taken these changes and merged them to the latest commit in https://github.com/ericstoekl/faas/tree/markdown-docs Should we create a new PR for this? What still needs to be done for this PR? |
@johnmccabe didn't sign all the commits off for this documentation site. Also the docs have progressed since this PR was opened 2 months ago so we'd need to check we are in sync. Not sure what the best option is for moving forward at this point. |
Signed-off-by: John McCabe <[email protected]>
@alexellis / @ericstoekl I've squashed and signed the WIP commits - have not touched the rebase to make the outstanding changes more visible. |
Main guts of this change in its current state are as follows:
To continue this would involve picking up on this getting started section, then some presentation updates around the guides sections etc to give a logical flow to them. @alexellis the very long build time (17min+) appeared to be blips on the Travis side (occuring once) - builds times range from |
ImportantThe |
@ericstoekl you said you'd re-based this? Is there a PR? |
I'll have a PR up later today.
…On Fri, Dec 29, 2017 at 1:45 AM, Alex Ellis ***@***.***> wrote:
@ericstoekl <https://github.com/ericstoekl> you said you'd re-based this?
Is there a PR?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#274 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/ABah_TPFk_of8Qn6y1G7E5Tth90J3ZL0ks5tFLTNgaJpZM4PzN8L>
.
--
Erich Stoekl
|
Closing as @ericstoekl is picking this up in #464 |
ack @johnmccabe - feel free to input into #464 with Eric |
Signed-off-by: John McCabe [email protected]
Description
Raising a WIP PR for the autogeneration of the documentation site. This includes both the autogeneration of the site, and also some moving, restructuring and updates to the current content in order to make the resulting site flow more cleanly and to fill out gaps/remote redundancy and repetition (the bit that involves work).
The current implementation goes with mkdocs with the material theme, with a custom monochrome logo, some light styling to the logo css and custom colour to match the openfaas.com site.
The WIP site is being deployed from the PR branch from my fork via Travis, it can be seen here:
Motivation and Context
How Has This Been Tested?
Testing for this is pending, we'll likely need the following
Types of changes
Checklist:
git commit -s