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.

Sign up for GitHub

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

Jump to bottom

docs: add more detail to documentation contribution guide #47381

Closed
wants to merge 1 commit into from
Closed

docs: add more detail to documentation contribution guide #47381

wants to merge 1 commit into from

Conversation

bob-watson
Copy link
Contributor

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 instructions to contribute content to the Angular documentation are sketchy and spread around the Angular repo.

Issue Number: N/A

What is the new behavior?

This update consolidates the instructions to update the documentation and provides detailed, illustrated procedures to help newcomers to Angular and GitHub be successful

Does this PR introduce a breaking change?

  • Yes
  • No

@ngbot ngbot bot added this to the Backlog milestone Sep 7, 2022
@bob-watson bob-watson added aio: preview target: patch This PR is targeted for the next patch release P1 Impacts a large percentage of users; if a workaround exists it is partial or overly painful labels Sep 7, 2022
@mary-poppins
Copy link

You can preview 33c82d1 at https://pr47381-33c82d1.ngbuilds.io/.

@bob-watson bob-watson added the action: review The PR is still awaiting reviews from at least one requested reviewer label Sep 19, 2022
@gkalpak gkalpak removed their request for review September 19, 2022 15:15
@mary-poppins
Copy link

You can preview 3e51437 at https://pr47381-3e51437.ngbuilds.io/.

@mary-poppins
Copy link

You can preview 620bd40 at https://pr47381-620bd40.ngbuilds.io/.

@mary-poppins
Copy link

You can preview c3da322 at https://pr47381-c3da322.ngbuilds.io/.

@mary-poppins
Copy link

You can preview 31cb1d6 at https://pr47381-31cb1d6.ngbuilds.io/.

@mary-poppins
Copy link

You can preview b1b95eb at https://pr47381-b1b95eb.ngbuilds.io/.

@mary-poppins
Copy link

You can preview 4d4089c at https://pr47381-4d4089c.ngbuilds.io/.

@mary-poppins
Copy link

You can preview 1e19ad8 at https://pr47381-1e19ad8.ngbuilds.io/.

@mary-poppins
Copy link

You can preview 3e616a8 at https://pr47381-3e616a8.ngbuilds.io/.

@bob-watson bob-watson marked this pull request as ready for review September 27, 2022 14:08
@mary-poppins
Copy link

You can preview 7d938c6 at https://pr47381-7d938c6.ngbuilds.io/.

@mgechev mgechev removed their request for review September 27, 2022 21:59
@pullapprove pullapprove bot requested a review from mgechev September 27, 2022 21:59
@bob-watson bob-watson removed the request for review from gkalpak September 28, 2022 13:39
josmar-crwdstffng
josmar-crwdstffng reviewed Sep 29, 2022
View reviewed changes
Copy link
Contributor

@josmar-crwdstffng josmar-crwdstffng left a comment

Choose a reason for hiding this comment

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

@bob-watson
I have reviewed most of the initial docs.
Most of of my feedback concerns markdown formatting that should be addressed prior to publication for all files.

aio/content/guide/contributors-guide-overview.md Outdated Show resolved Hide resolved
aio/content/guide/contributors-guide-overview.md Outdated Show resolved Hide resolved
aio/content/guide/contributors-guide-overview.md Outdated Show resolved Hide resolved
aio/content/guide/contributors-guide-overview.md Outdated Show resolved Hide resolved
aio/content/guide/contributors-guide-overview.md Outdated Show resolved Hide resolved
aio/content/guide/doc-pr-update.md Outdated Show resolved Hide resolved
aio/content/guide/doc-pr-update.md Outdated Show resolved Hide resolved
aio/content/guide/doc-pr-update.md Outdated Show resolved Hide resolved
aio/content/guide/doc-pr-update.md Outdated Show resolved Hide resolved
aio/content/guide/doc-pr-update.md Outdated Show resolved Hide resolved
@josmar-crwdstffng josmar-crwdstffng mentioned this pull request Sep 30, 2022
Closed
@mary-poppins
Copy link

You can preview 5f10809 at https://pr47381-5f10809.ngbuilds.io/.

@bob-watson
Copy link
Contributor Author

The latest commit includes the accepted changes from @josmar-crwdstffng's recent review and edits in #47596.

This merge closes #47596.

@mgechev mgechev added the action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews label Oct 12, 2022
@angular-robot angular-robot bot requested a review from mgechev October 12, 2022 13:21
@mary-poppins
Copy link

You can preview 977cfdf at https://pr47381-977cfdf.ngbuilds.io/.

@mary-poppins
Copy link

You can preview 1f28b04 at https://pr47381-1f28b04.ngbuilds.io/.

@mary-poppins
Copy link

You can preview 198b054 at https://pr47381-198b054.ngbuilds.io/.

docs: update of documentation contrib. guide
367cce2 
This update describes the content authoring and revision process in sufficient detail for technical and non-technical contributors to the angular.io documentation.
@mary-poppins
Copy link

You can preview 367cce2 at https://pr47381-367cce2.ngbuilds.io/.

@bob-watson bob-watson added action: merge The PR is ready for merge by the caretaker and removed action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews action: review The PR is still awaiting reviews from at least one requested reviewer labels Oct 12, 2022
@jessicajaniuk
Copy link
Contributor

This PR was merged into the repository by commit 6c98ca4.

jessicajaniuk pushed a commit that referenced this pull request Oct 13, 2022
@thePunderWoman
docs: update of documentation contrib. guide (#47381)
955edf2 
This update describes the content authoring and revision process in sufficient detail for technical and non-technical contributors to the angular.io documentation.

PR Close #47381
jessicajaniuk pushed a commit that referenced this pull request Oct 13, 2022
@thePunderWoman
docs: update of documentation contrib. guide (#47381)
2ca2137 
This update describes the content authoring and revision process in sufficient detail for technical and non-technical contributors to the angular.io documentation.

PR Close #47381
@angular-automatic-lock-bot
Copy link

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 Nov 13, 2022
@bob-watson bob-watson deleted the update-doc-contribution branch November 21, 2022 18:29
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@mgechev mgechev mgechev approved these changes

@josmar-crwdstffng josmar-crwdstffng josmar-crwdstffng approved these changes

Assignees
No one assigned
Labels
action: merge The PR is ready for merge by the caretaker aio: preview P1 Impacts a large percentage of users; if a workaround exists it is partial or overly painful 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 @josmar-crwdstffng @jessicajaniuk @mgechev