Docs overhaul #1396
Merged
Docs overhaul #1396
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
|
Deploy preview for chef-workstation ready! Built with commit c74aa63 |
From the Buildkite failure. Do we need to re-fetch the git submodule? Or is this work still in flight on the |
|
@tyler-ball There are changes I have to make in chef-web-docs after this PR is merged. |
|
@IanMadd is there any way to get the deploy preview passing? |
added 6 commits
August 13, 2020 12:42
Signed-off-by: IanMadd <imaddaus@chef.io>
Signed-off-by: IanMadd <imaddaus@chef.io>
Signed-off-by: IanMadd <imaddaus@chef.io>
Signed-off-by: IanMadd <imaddaus@chef.io>
Signed-off-by: IanMadd <imaddaus@chef.io>
Signed-off-by: IanMadd <imaddaus@chef.io>
9e06316 to
1732ed5
Compare
Signed-off-by: IanMadd <imaddaus@chef.io>
1732ed5 to
f3295d1
Compare
|
@marcparadise That should take care of it. |
tyler-ball
approved these changes
Aug 18, 2020
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.
Description
This is a bit of docs overhaul.
Note: Netlify is not going to be able to build this PR preview because there are changes that I have to make with the theme in chef-web-docs after this PR and another PR in
desktop-configare merged.Related Issue
We're removing the shortcodes chef-workstation (and other repos) because they're not really working as intended.
The intent of shortcodes is that we have reusable text that will be identical no matter where it is added. The problem is that we are documenting the same things across multiple repos. We came up with the practice of adding shortcodes that are used in repos other than
chef-web-docsby adding a prefix to each shortcode file name depending on the repository that they're added to, but we've ended up with multiple shortcodes that have slightly different names but the same text.This creates problems if the text in a shortcode is updated in one repository, but the matching text is not updated in matching shortcodes in other repositories. The other issue we have is that some shortcodes are only used once in their repositories. Both of these issues defeats the purpose of shortcodes, which is that we have reusable text that can be used in multiple places and is identical no matter where it is added.
So now we'll just keep all shortcodes in
chef-web-docs/themes/docs-new/layouts/shortcodesand all changes to that text should be made there.Types of changes
Checklist: