contiv / contiv.github.io

Contiv website source code
http://contiv.github.io/
Other
3 stars 65 forks source link

Moved contribution information to CONTRIBUTING.md #120

Closed dseevr closed 7 years ago

dseevr commented 7 years ago

Signed-off-by: Bill Robinson dseevr@users.noreply.github.com

dseevr commented 7 years ago

I have no idea how anything is done aside from copying the API doc from contivmodel. I can add a note for that, but someone else will have to add the details for go doc and anything else that is relevant

dseevr commented 7 years ago

Updated with info about updating the API Reference page. Who can write up instructions for go doc and the other stuff?

rhim commented 7 years ago

For godoc, ask Ranjith for instructions - most likely it is just a footnote in the doc saying that goes through the PR process since it is auto-gen from code.

I believe other stuff is just editing the site itself, so can be left out.

On Mar 28, 2017, at 10:35 AM, Bill Robinson notifications@github.com<mailto:notifications@github.com> wrote:

Updated with info about updating the API Reference page. Who can write up instructions for go doc and the other stuff?

— You are receiving this because your review was requested. Reply to this email directly, view it on GitHubhttps://github.com/contiv/contiv.github.io/pull/120#issuecomment-289846231, or mute the threadhttps://github.com/notifications/unsubscribe-auth/AMiMKera-Q31_SMnGiWJ0dnOxK8aOQVdks5rqUTagaJpZM4Mr7Ts.

dseevr commented 7 years ago

The go doc stuff is autogenerated from Github (there's a manual "refresh" button at the bottom of the page) and not even hosted on the Contiv website, so I don't think we need to add anything for that...

Anything else to add here?

dseevr commented 7 years ago

Added a note about how GoDoc works and how to manually refresh it, too