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

fix(docs): create a new page for How-tos sidebar section #2076

Merged
merged 1 commit into from Nov 26, 2018

Conversation

Projects
None yet
2 participants
@bajtos
Member

bajtos commented Nov 26, 2018

Rename "How tos" to "How-tos", I find "How tos" as difficult to read.

Add a new page docs/site/How-tos.md and use it to back "How-tos"
section. Before this change, both "How-tos" and "Key concepts" were
sharing the same section page, which was confusing.

BEFORE

screen shot 2018-11-26 at 12 32 55

AFTER

screen shot 2018-11-26 at 12 33 28

Checklist

  • npm test passes on your machine
  • New tests added or existing tests modified to cover all changes
  • Code conforms with the style guide
  • API Documentation in code was updated
  • Documentation in /docs/site was updated
  • Affected artifact templates in packages/cli were updated
  • Affected example projects in examples/* were updated

@bajtos bajtos added the Docs label Nov 26, 2018

@bajtos bajtos self-assigned this Nov 26, 2018

@bajtos bajtos requested a review from dhmlau Nov 26, 2018

@bajtos bajtos requested a review from raymondfeng as a code owner Nov 26, 2018

@dhmlau

Thanks Miroslav. Your changes are generally LGTM. I'm not sure if HOWTOs would be a good replacement of the current title. I tried to look up documentation in other products/frameworks and didn't find a good reference. @bschrammIBM, any inputs? Thanks.

@bajtos

This comment has been minimized.

Member

bajtos commented Nov 26, 2018

I'm not sure if HOWTOs would be a good replacement of the current title. I tried to look up documentation in other products/frameworks and didn't find a good reference.

Few alternative that come to my mind:

  • How-tos
  • Guides
  • Tutorials (I feel this title is not very accurate, tutorials are usually different and covering simpler tasks)

Personally, I like "Guides" most.

@bajtos

This comment has been minimized.

Member

bajtos commented Nov 26, 2018

We have discussed this with @dhmlau in a chat and agreed to use How-tos for now. We can always revisit this later if needed.

See also https://english.stackexchange.com/questions/154563/what-is-the-plural-of-how-to

fix(docs): create a new page for HOWTOs sidebar section
Rename "How tos" to "HOWTOs", I find "How tos" as difficult to read.

Add a new page `docs/site/Howtos.md` and use it to back "HOWTOs"
section. Before this change, both "HOWTOs" and "Key concenpts" were
sharing the same section page, which was confusing.

@bajtos bajtos force-pushed the docs/fix-howtos branch from d2b79f6 to 0dd2ce1 Nov 26, 2018

@bajtos bajtos changed the title from fix(docs): create a new page for HOWTOs sidebar section to fix(docs): create a new page for How-tos sidebar section Nov 26, 2018

@bajtos

This comment has been minimized.

Member

bajtos commented Nov 26, 2018

@dhmlau LGTY now?

@dhmlau

dhmlau approved these changes Nov 26, 2018

@bajtos bajtos merged commit 164e125 into master Nov 26, 2018

3 of 4 checks passed

continuous-integration/appveyor/pr Waiting for AppVeyor build to complete
Details
clahub All contributors have signed the Contributor License Agreement.
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
security/snyk - package.json (dhmlau) No manifest changes detected

@bajtos bajtos deleted the docs/fix-howtos branch Nov 26, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment