Skip to content
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

Documentation Overhaul #289

Merged
merged 1 commit into from
Oct 29, 2018
Merged

Documentation Overhaul #289

merged 1 commit into from
Oct 29, 2018

Conversation

vkorbes
Copy link
Contributor

@vkorbes vkorbes commented Sep 20, 2018

Here's the initial version of our new docs.

Notes:

  • Internal links should all be working, but please do check the external ones.
  • The references section hasn't been reviewed, so it's probably out of date. We'll fix it on the next stage.
  • Links still need to be added in the example project guides to the actual files where the projects are. Pending Mirror examples to separate repo #128.
  • For missing files, TODO stuff that you'd like to note down and so on, please use the Docs Work base in Airtable.

Articles/guides that we probably want but that are still pending:

  • A project involving hot reload
  • The socks shop project
  • Migration guide from Docker Compose to Garden
  • Getting started with Kubernetes using the Garden framework
  • Contributing to Garden

Closes #274.

@vkorbes vkorbes changed the title WIP: Documentation Overhaul Documentation Overhaul Oct 10, 2018
@vkorbes vkorbes force-pushed the allthedocs branch 2 times, most recently from 063100a to 6c4c9ef Compare October 11, 2018 08:48
@eysi09 eysi09 requested a review from thsig October 18, 2018 12:06
docs-old/README.md Outdated Show resolved Hide resolved
docs-old/examples/simple-project.md Outdated Show resolved Hide resolved
docs-old/examples/simple-project.md Outdated Show resolved Hide resolved
docs-old/examples/simple-project.md Outdated Show resolved Hide resolved
docs-old/examples/simple-project.md Outdated Show resolved Hide resolved
docs/using-garden/features-and-usage.md Outdated Show resolved Hide resolved
docs/using-garden/features-and-usage.md Outdated Show resolved Hide resolved
docs/using-garden/features-and-usage.md Show resolved Hide resolved
docs/using-garden/hot-reload.md Outdated Show resolved Hide resolved
docs/using-garden/hot-reload.md Outdated Show resolved Hide resolved
@drubin
Copy link
Contributor

drubin commented Oct 24, 2018

I imported this project into a "test" gitbook project to be able to see how it gets formatted.

I think we need to tweak a few things?

https://davidgarden.gitbook.io/allthedocs/v/allthedocs/

cc/ @eysi09 @ellenkorbes

@eysi09 eysi09 merged commit 3b5e5e5 into master Oct 29, 2018
@eysi09 eysi09 deleted the allthedocs branch October 29, 2018 13:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation Overhaul
4 participants