docs: restructure and add new basic guides #1300
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eysi09
force-pushed
the
docs-restructure
branch
from
22e9757 to
cb80270
Compare
edvald
requested changes
Nov 5, 2019
edvald
requested changes
Nov 5, 2019
2 tasks
eysi09
force-pushed
the
docs-restructure
branch
from
cb80270 to
6fe66f5
Compare
|
Addressed the PR comments in a separate commit. |
eysi09
force-pushed
the
docs-restructure
branch
from
6fe66f5 to
802b05b
Compare
eysi09
changed the title
edvald
requested changes
Nov 6, 2019
docs/using-garden/adding-services.md
Outdated
| @@ -102,8 +100,14 @@ services: | |||
|
|
|||
| ### Kubernetes Providers | |||
There was a problem hiding this comment.
The title seems a little odd. Maybe just skip it?
edvald
approved these changes
Nov 6, 2019
Note: This will fail in CI since the links we're updating haven't breen created yet on docs.garden.io. They will be created automatically though on merge to master, so we can safely ignore the CI check.
eysi09
force-pushed
the
docs-restructure
branch
from
4e2ee0c to
644ab65
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR re-names the Using Garden section of our docs to Guides and adds a new Using Garden section. The new section contains a guide for each of the main Garden primitives: project, module, service, test, and task.
The idea was for each of these guides to be short, to the point, and independent of other context. So you can go through these one by one as you're adding these primitives to your project. You can also imagine a user who already has a project with modules and services and now wants to start using Garden to run their tests. They should then be able to go straight to Using Garden > Running Tests and find everything they need to get started.
This is still a work in progress but open for review.
One thing I've found challenging is balancing the abstract and the concrete. For example writing about services as an abstract Garden primitive, and at they same time give concrete and useful examples which are of course specific to different plugins.
So I'm assuming we'll have to do some iterations on this. All comments, suggestions, nitpicks, etc are therefore very much appreciated.