WIP: Splits out provider-specific parts of Beginner's Guide to CE #208
Conversation
This file contains hidden or 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
|
|
DougReeder
force-pushed
the
split-beginners
branch
from
0a4f3ab to
e6469dc
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 is a rough draft of structure I'd like to see. Don't sweat the heirarchy of steps at this stage. First we need consensus on what approach we take.
This would not be implemented until after the Beginner's Guide has been published in its current form — we don't want to delay that.
What?
Splits out sections of Beginner's Guide to CE that apply to only one provider into separate documents.
The high level steps, and low-level steps that are common to all providers remain in the main document.
Only a few provider-specific pages are included in this draft.
Also starts adding callouts on verifying the step has been implemented correctly.
Why?
Dozens of people have written guides to installing CE. They are great if you are using the same providers.
If you're not, you have to interpolate between different documents, which gets confusing and is error-prone.
At a high level, the steps are the same no matter what providers you use — only the detailed steps for each provider are different.
This structure allows users to proceed through installation without having to skip sections irrelevant to them.
It also makes clear where there are alternatives, and where there are not.
The new callouts help a user to verify that the low-level steps were completed correctly. If verification fails, they know which steps to review.
How to test
Limitations
The initial merge will only contain a few provider-specific pages drawn from the current documentation.
Alternatives considered
Writing a guide like the Beginner's Guide for every combination of providers would result in a combinatoric explosion..
We should decide whether sections containing detailed steps that all users must follow should be in the main document, or split out like provider-specific steps.