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

API Libraries Design update #376

Merged
merged 10 commits into from
Nov 6, 2020
Merged

API Libraries Design update #376

merged 10 commits into from
Nov 6, 2020

Conversation

F4NT0
Copy link
Contributor

@F4NT0 F4NT0 commented Oct 9, 2020

Why:

Resolving the Issue #352

What's being changed:

  • GIF showing the visual Change

libraries_update

  • One Example of how the markdown is organized, to be more easy to increase the number of Libraries
### JavaScript

Library name | Oficial Github Repository |
|---|---|
**NodeJS Github library**| [pksunkara/octonode](https://github.com/pksunkara/octonode)
**gh3 client-side API v3 wrapper**| [k33g/gh3](https://github.com/k33g/gh3)
**Github.js wrapper around the Github API**|[michael/github](https://github.com/michael/github)
**Promise-Based CoffeeScript library for the Browser or NodeJS**|[philschatz/github-client](https://github.com/philschatz/github-client)

Check off the following:

@F4NT0 F4NT0 requested a review from a team as a code owner October 9, 2020 23:36
@welcome
Copy link

welcome bot commented Oct 9, 2020

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@heiskr heiskr removed the request for review from a team October 12, 2020 19:44
@simpsoka
Copy link
Contributor

This is great, thank you @F4NT0! From a product perspective - this definitely is easier to read, the content also gives more contextual information about the libraries. Would love to get this triaged, so cc'ing @heiskr for docs-engineering review.

@heiskr
Copy link
Contributor

heiskr commented Oct 20, 2020

I like the look of the page for sure. There's a few changes I think we'd need to get this to a merge-able state.

  • Where the table headings say "Oficial Github Repository".... I don't want to imply GitHub actually maintains these projects. Would it be possible to reduce to simply "Repository"?
  • We also spell the company name "GitHub", with a capital "H". The brand folks are particular about that. Would it be possible to get those updated as well?
  • We'd also prefer to not include changes to package.json and package-lock.json for the scope of this pull request. Its fine to be in the commit history as we squash commits, if you could run like git checkout main package.json package-lock.json and commit the reversion on those.

Thank you!

Copy link
Contributor

@runleonarun runleonarun left a comment

Choose a reason for hiding this comment

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

Thanks for contributing to this article, @F4NT0! I made some suggestions. Once these and @heiskr's suggestions are addressed, we can ship this PR!

content/rest/overview/libraries.md Outdated Show resolved Hide resolved
content/rest/overview/libraries.md Outdated Show resolved Hide resolved
content/rest/overview/libraries.md Outdated Show resolved Hide resolved
content/rest/overview/libraries.md Outdated Show resolved Hide resolved
@janiceilene janiceilene added the hacktoberfest-accepted We might not merge this PR before Nov 1st, but it's a wonderful Hacktoberfest contribution! label Oct 27, 2020
package.json Outdated Show resolved Hide resolved
Copy link
Contributor

@heiskr heiskr left a comment

Choose a reason for hiding this comment

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

🙌🏼 Thank you 💃🏼

@github-actions
Copy link
Contributor

github-actions bot commented Nov 5, 2020

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Nov 5, 2020
@F4NT0
Copy link
Contributor Author

F4NT0 commented Nov 5, 2020

Waiting for @runleonarun approve this PR!

Copy link
Contributor

@runleonarun runleonarun left a comment

Choose a reason for hiding this comment

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

@F4NT0 Thank you for the reminder! Nice work on this PR 🙇‍♀️

@runleonarun runleonarun merged commit 5b17e72 into github:main Nov 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted We might not merge this PR before Nov 1st, but it's a wonderful Hacktoberfest contribution! stale There is no recent activity on this issue or pull request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants