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

Reorg Style Guide #2956

Merged
merged 15 commits into from
May 7, 2021
Merged

Reorg Style Guide #2956

merged 15 commits into from
May 7, 2021

Conversation

kagarmoe
Copy link
Contributor

@kagarmoe kagarmoe commented Feb 22, 2021

Signed-off-by: kagarmoe kgarmoe@chef.io

Description

Our Style Guide is long and hard to follow. This PR is a start on reworking it.
The intent is to make our guide easier to use for onboarding new writers and devs.

Pages

https://deploy-preview-2956--chef-web-docs.netlify.app/style_house/
https://deploy-preview-2956--chef-web-docs.netlify.app/style_markdown/
https://deploy-preview-2956--chef-web-docs.netlify.app/style_hugo/
https://deploy-preview-2956--chef-web-docs.netlify.app/style_html/

Definition of Done

Issues Resolved

[List any existing issues this PR resolves, or any Discourse or
StackOverflow discussion that's relevant]

Check List

  • Spell Check
  • Local build
  • Examine the local build
  • All tests pass

@netlify
Copy link

netlify bot commented Feb 22, 2021

Deploy preview for chef-web-docs ready!

Built with commit a566f2a

https://deploy-preview-2956--chef-web-docs.netlify.app

content/style_hugo.md Outdated Show resolved Hide resolved
content/style_hugo.md Outdated Show resolved Hide resolved
@IanMadd
Copy link
Contributor

IanMadd commented Feb 22, 2021

This reorganization is definitely a good idea.

content/style_html.md Outdated Show resolved Hide resolved
content/style_html.md Outdated Show resolved Hide resolved
content/style_html.md Outdated Show resolved Hide resolved
content/style_reuse.md Outdated Show resolved Hide resolved
@IanMadd
Copy link
Contributor

IanMadd commented Mar 30, 2021

The content in style_reuse.md and style_html.md cover the same ground, so they should probably be merged into one page.

@kagarmoe kagarmoe added Type: Docs Debt For @docs-team. Managing projects, nav, ssg, search, test, and build. Type: Chore non-critical maintenance of a project. and removed Type: Docs Debt For @docs-team. Managing projects, nav, ssg, search, test, and build. Type: Chore non-critical maintenance of a project. labels Apr 8, 2021
@kagarmoe kagarmoe marked this pull request as ready for review May 7, 2021 20:32
@kagarmoe kagarmoe requested a review from a team as a code owner May 7, 2021 20:32
Copy link
Contributor

@IanMadd IanMadd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tenor-185238376

@kagarmoe kagarmoe self-assigned this May 7, 2021
kagarmoe and others added 5 commits May 7, 2021 15:04
Signed-off-by: kagarmoe <kgarmoe@chef.io>
Signed-off-by: Ian Maddaus <imaddaus@chef.io>
Signed-off-by: Ian Maddaus <imaddaus@chef.io>
Signed-off-by: IanMadd <imaddaus@chef.io>
IanMadd and others added 10 commits May 7, 2021 15:04
Signed-off-by: IanMadd <imaddaus@chef.io>
Signed-off-by: IanMadd <imaddaus@chef.io>
Signed-off-by: kagarmoe <kgarmoe@chef.io>
Signed-off-by: kagarmoe <kgarmoe@chef.io>
Signed-off-by: IanMadd <Ian.Maddaus@progress.com>
Signed-off-by: IanMadd <Ian.Maddaus@progress.com>
Signed-off-by: kagarmoe <kgarmoe@chef.io>
Signed-off-by: kagarmoe <kgarmoe@chef.io>
Signed-off-by: Ian Maddaus <Ian.Maddaus@progress.com>
Signed-off-by: Ian Maddaus <Ian.Maddaus@progress.com>
@kagarmoe kagarmoe merged commit bfdc4c2 into master May 7, 2021
@kagarmoe kagarmoe deleted the kg/style-reorg branch May 7, 2021 22:08
@tas50 tas50 added Aspect: Documentation How do we use this project? and removed Documentation labels May 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Aspect: Documentation How do we use this project? Type: Docs Debt For @docs-team. Managing projects, nav, ssg, search, test, and build.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants