Skip to content

Reorg repo and README #105

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

Merged
merged 15 commits into from
Sep 10, 2018
Merged

Reorg repo and README #105

merged 15 commits into from
Sep 10, 2018

Conversation

bcomnes
Copy link
Contributor

@bcomnes bcomnes commented Sep 8, 2018

Here are some ideas I had to reorganize this repo.

@bcomnes
Copy link
Contributor Author

bcomnes commented Sep 8, 2018

a few pointers from Irene

  • keep the old intro text

README.md Outdated

See [swagger-js](https://github.com/swagger-api/swagger-js)
See [CONTRIBUTING.md#go-client](CONTRIBUTING.md) for details on how this client is developed and generated.
Copy link
Contributor

Choose a reason for hiding this comment

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

do we need #go-client here (looks like it's not really pointing to anywhere specifically in contributing)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixing

README.md Outdated
@@ -1,47 +1,39 @@
# Netlify open-api
# open-api
[![Build Status](https://travis-ci.org/netlify/open-api.svg?branch=master)](https://travis-ci.org/netlify/open-api) [![Build status](https://ci.appveyor.com/api/projects/status/qrmvxk957ou2yrd9/branch/master?svg=true)](https://ci.appveyor.com/project/netlify/open-api/branch/master)
Copy link
Contributor

Choose a reason for hiding this comment

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

can we have a new line for each status? I think it still renders the same way

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixing

@keiko713
Copy link
Contributor

keiko713 commented Sep 8, 2018

Left some comments but overall I like this change a lot!

README.md Outdated
Swagger's JS client can dynamically create a client from a spec either from a URL or spec object.
- [Porcelain](https://godoc.org/github.com/netlify/open-api/go/porcelain): High level interactions and operations
- [Plumbing](https://godoc.org/github.com/netlify/open-api/go/plumbing): Low level client operations
- [Models](https://godoc.org/github.com/netlify/open-api/go/porcelain): Models generated by [go-swagger]()
Copy link
Contributor

Choose a reason for hiding this comment

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

link is missing

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixing

README.md Outdated

Swagger's JS client can dynamically create a client from a spec either from a URL or spec object.
- [Porcelain](https://godoc.org/github.com/netlify/open-api/go/porcelain): High level interactions and operations
- [Plumbing](https://godoc.org/github.com/netlify/open-api/go/plumbing): Low level client operations
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe add "generated by go-swagger" here as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixing

@bcomnes
Copy link
Contributor Author

bcomnes commented Sep 9, 2018

Thanks for the review @keiko713 ! I'll incorporate these changes.

@bcomnes
Copy link
Contributor Author

bcomnes commented Sep 10, 2018

Okiedoke, this should be good now.

@bcomnes bcomnes merged commit c5a5c79 into master Sep 10, 2018
@bcomnes bcomnes deleted the reorg branch September 10, 2018 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants