Skip to content

docs: edit topic titles in ToC and move content contribution section in ToC#47083

Closed
bob-watson wants to merge 1 commit intoangular:mainfrom
bob-watson:content-nav-update
Closed

docs: edit topic titles in ToC and move content contribution section in ToC#47083
bob-watson wants to merge 1 commit intoangular:mainfrom
bob-watson:content-nav-update

Conversation

@bob-watson
Copy link
Contributor

@bob-watson bob-watson commented Aug 8, 2022

  • set all titles in left nav to sentence case
  • move documentation contribution guide to top-level of ToC from inside the Reference topics
  • update overview and reviewing topics to accommodate new ToC organization

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • angular.io application / infrastructure changes
  • Other... Please describe:

What is the current behavior?

The documentation contribution guidelines were in the Reference section, but they really aren't reference topics. They're more procedural and would benefit from better visibility in the ToC.

Issue Number: N/A

What is the new behavior?

The documentation contribution guidelines are now titled more clearly and visible in the top-level of the documentation's left nav.

Does this PR introduce a breaking change?

  • Yes
  • No

@bob-watson bob-watson added action: review The PR is still awaiting reviews from at least one requested reviewer aio: preview doc-topic: reference Use only with "comp: docs" for issues in the reference topics labels Aug 8, 2022
@pullapprove pullapprove bot requested review from jessicajaniuk and mgechev August 8, 2022 21:47
@ngbot ngbot bot added this to the Backlog milestone Aug 8, 2022
@mary-poppins
Copy link

mary-poppins commented Aug 8, 2022

You can preview 24ecbcc at https://pr47083-24ecbcc.ngbuilds.io/.

jessicajaniuk
jessicajaniuk approved these changes Aug 8, 2022
View reviewed changes
Copy link
Contributor

@jessicajaniuk jessicajaniuk left a comment

Choose a reason for hiding this comment

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

This looks good to me other than the one line with the comma that needs to be fixed.

This is non-blocking, but it would be nice if we had some info in the contributors guide on commit messages, keeping commits to only the relevant minimum, and squashing unnecessary commits before putting up a PR. We could also link to guides on how to use interactive rebase appropriately. People seem to really struggle when we ask them to squash commits. I'd be happy to add this in a separate PR, too.

@bob-watson
Copy link
Contributor Author

bob-watson commented Aug 8, 2022 •
edited
Loading

@jessicajaniuk Thanks for the feedback.
This is a first step in making content contributions friendly. The more I dig into this, the more work I see it needs, but I wanted to get the ball rolling by bringing this section of content into the light.

@mary-poppins
Copy link

mary-poppins commented Aug 9, 2022

You can preview 69e06b7 at https://pr47083-69e06b7.ngbuilds.io/.

@mary-poppins
Copy link

mary-poppins commented Aug 9, 2022

You can preview 67c8117 at https://pr47083-67c8117.ngbuilds.io/.

@bob-watson bob-watson added target: patch This PR is targeted for the next patch release and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Aug 10, 2022
@mary-poppins
Copy link

mary-poppins commented Aug 10, 2022

You can preview 24814dd at https://pr47083-24814dd.ngbuilds.io/.

@bob-watson bob-watson removed the request for review from josmar-crwdstffng August 11, 2022 20:55
@mary-poppins
Copy link

mary-poppins commented Aug 11, 2022

You can preview 0ce39fe at https://pr47083-0ce39fe.ngbuilds.io/.

mgechev
mgechev reviewed Aug 11, 2022
View reviewed changes
aio/content/guide/contributors-guide-overview.md Outdated
Copy link
Member

@mgechev mgechev Aug 11, 2022

Choose a reason for hiding this comment

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

We can also explain the simple path. Clicking on the edit button enables folks to easily fix typos.

mgechev
mgechev approved these changes Aug 11, 2022
View reviewed changes
Copy link
Member

@mgechev mgechev left a comment

Choose a reason for hiding this comment

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

LGTM. My only suggestion is to consider including the simple path for making small fixes via the GitHub UI in the contributor guide.

@angular-robot angular-robot bot requested a review from mgechev August 12, 2022 00:06
@mary-poppins
Copy link

mary-poppins commented Aug 12, 2022

You can preview 8a60ebd at https://pr47083-8a60ebd.ngbuilds.io/.

@bob-watson bob-watson removed the request for review from mgechev August 12, 2022 15:07
docs: set titles to sentence case
32831be 
* update overview and reviewing topics to accommodate new ToC
* incorporate edits from peer reviews
@angular-robot angular-robot bot requested a review from mgechev August 12, 2022 15:36
@bob-watson bob-watson removed the request for review from mgechev August 12, 2022 15:38
@bob-watson bob-watson added the action: merge The PR is ready for merge by the caretaker label Aug 12, 2022
@mary-poppins
Copy link

mary-poppins commented Aug 12, 2022

You can preview 32831be at https://pr47083-32831be.ngbuilds.io/.

@pkozlowski-opensource
Copy link
Member

pkozlowski-opensource commented Aug 12, 2022

This PR was merged into the repository by commit 757684b.

pkozlowski-opensource pushed a commit that referenced this pull request Aug 12, 2022
@pkozlowski-opensource
docs: set titles to sentence case (#47083)
bb465e1 
* update overview and reviewing topics to accommodate new ToC
* incorporate edits from peer reviews

PR Close #47083
@bob-watson bob-watson deleted the content-nav-update branch August 12, 2022 17:46
@angular-automatic-lock-bot
Copy link

angular-automatic-lock-bot bot commented Sep 12, 2022

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 12, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@mgechev mgechev mgechev approved these changes

+1 more reviewer

@jessicajaniuk jessicajaniuk jessicajaniuk approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

action: merge The PR is ready for merge by the caretaker doc-topic: reference Use only with "comp: docs" for issues in the reference topics target: patch This PR is targeted for the next patch release

Projects

None yet

Milestone

Backlog

Development

Successfully merging this pull request may close these issues.

5 participants

@bob-watson @mary-poppins @pkozlowski-opensource @mgechev @jessicajaniuk