Skip to content

docs: update readme#32084

Closed
sjtrimble wants to merge 8 commits into
angular:masterfrom
sjtrimble:readme-redesign
Closed

docs: update readme#32084
sjtrimble wants to merge 8 commits into
angular:masterfrom
sjtrimble:readme-redesign

Conversation

@sjtrimble
Copy link
Copy Markdown
Contributor

@sjtrimble sjtrimble commented Aug 9, 2019

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?

Issue Number: N/A

What is the new behavior?

Updated README file to improve usability

Does this PR introduce a breaking change?

  • Yes
  • No

@sjtrimble sjtrimble requested a review from a team August 9, 2019 17:18
@sjtrimble
Copy link
Copy Markdown
Contributor Author

sjtrimble commented Aug 9, 2019

Need to add a few images still.

Initial design (not pixel perfect, just for reference):
readme-redesign

@sjtrimble sjtrimble requested a review from gkalpak August 9, 2019 17:18
@sjtrimble sjtrimble self-assigned this Aug 9, 2019
@sjtrimble sjtrimble requested a review from IgorMinar as a code owner August 9, 2019 20:00
@sjtrimble sjtrimble mentioned this pull request Aug 9, 2019
Closed
14 tasks
gkalpak
gkalpak reviewed Aug 9, 2019
View reviewed changes
Copy link
Copy Markdown
Member

@gkalpak gkalpak left a comment

Choose a reason for hiding this comment

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

In general, I believe it is better to use markdown as much as possible and only resort to HTML if absolutely necessary.

Comment thread README.md Outdated
Comment thread README.md Outdated
@sjtrimble sjtrimble force-pushed the readme-redesign branch 8 times, most recently from 01bb23a to 83b9ef1 Compare August 9, 2019 20:45
@sjtrimble
Copy link
Copy Markdown
Contributor Author

sjtrimble commented Aug 9, 2019

Currently broken ... can't get the second image to show up.

@ngbot ngbot Bot added this to the needsTriage milestone Aug 14, 2019
@ngbot ngbot Bot modified the milestones: needsTriage, Backlog Aug 14, 2019
@ajitsinghkaler
Copy link
Copy Markdown
Contributor

ajitsinghkaler commented Feb 9, 2020

@sjtrimble @gkalpak this seems nearly complete is there a blocker for this, If needed I can help on this

@sjtrimble
Copy link
Copy Markdown
Contributor Author

sjtrimble commented Feb 10, 2020

@ajitsinghkaler If you'd like to help -> could you help me to get the second image to show up? I think the md is not formatted properly and it's causing formatting issues.

@ajitsinghkaler
Copy link
Copy Markdown
Contributor

ajitsinghkaler commented Feb 10, 2020 •
edited
Loading

@sjtrimble can you please tell me which image is not loading

as far as I can see al img tags are loading perfectly on my pc

@sjtrimble
Copy link
Copy Markdown
Contributor Author

sjtrimble commented Aug 13, 2020

I think this is ready for another review :) @ajitsinghkaler @gkalpak

@gkalpak gkalpak added action: review The PR is still awaiting reviews from at least one requested reviewer and removed state: WIP labels Sep 13, 2020
gkalpak
gkalpak suggested changes Sep 13, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@gkalpak gkalpak left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Nice! Almost lgtm 🎉

To fix CI (failing job), you need to add the newly added docs/images/ directory to a code-owner group. Currently, the README.md file is owned by dev-infra (as are most of the files in docs/), so it makes sense to assign docs/images/ to dev-infra too.

To do that, you need to add a new line in .pullapprove.yml:

           'docs/TRIAGE_AND_LABELS.md',
+          'docs/images/**',
           'goldens/*',

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@pullapprove pullapprove Bot requested a review from alxhub September 21, 2020 20:16
@sjtrimble
Copy link
Copy Markdown
Contributor Author

sjtrimble commented Sep 21, 2020

@gkalpak Okay, I think I covered the remaining items. Let me know if you see anything else. We'll see how the CI does :)

gkalpak
gkalpak approved these changes Sep 22, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@gkalpak gkalpak left a comment

Choose a reason for hiding this comment

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

🎉

@gkalpak gkalpak added action: merge The PR is ready for merge by the caretaker 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 Sep 22, 2020
@AndrewKushnir
Copy link
Copy Markdown
Contributor

AndrewKushnir commented Oct 15, 2020 •
edited
Loading

It looks like this PR is almost ready for merge!

@gkalpak @sjtrimble, could you please rebase this PR and resolve the conflict, so that we re-run the CI and proceed with the merge?

Thank you.

@gkalpak gkalpak force-pushed the readme-redesign branch 2 times, most recently from dfeeeca to fcf3dc0 Compare October 15, 2020 11:29
@gkalpak
Copy link
Copy Markdown
Member

gkalpak commented Oct 15, 2020

Rebased and resolved conflicts.

I also updated the badges (see images below for the difference):

  • Replace Gitter with Discord (as is already done in README.md on master).
  • Make the badges look more consistent with each other.
  • Include logos.
  • Add a little more horizontal space between badges.

BEFORE:
ng-badges before

AFTER:
ng-badges after

@gkalpak gkalpak removed the request for review from alxhub October 15, 2020 12:26
AndrewKushnir pushed a commit that referenced this pull request Oct 15, 2020
@sjtrimble @AndrewKushnir
docs: update readme (#32084)
cd4388e 
PR Close #32084
AndrewKushnir pushed a commit that referenced this pull request Oct 15, 2020
@sjtrimble @AndrewKushnir
docs: update readme (#32084)
6efbc8b 
PR Close #32084
@angular-automatic-lock-bot
Copy link
Copy Markdown

angular-automatic-lock-bot Bot commented Nov 15, 2020

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 15, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@AndrewKushnir AndrewKushnir AndrewKushnir approved these changes

+1 more reviewer

@gkalpak gkalpak gkalpak approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@sjtrimble sjtrimble

Labels

action: merge The PR is ready for merge by the caretaker cla: yes effort2: days risk: low target: patch This PR is targeted for the next patch release type: bug/fix

Projects

None yet

Milestone

Backlog

Development

Successfully merging this pull request may close these issues.

7 participants

@sjtrimble @ajitsinghkaler @AndrewKushnir @gkalpak @kara @kapunahelewong @googlebot