openbmc / docs

OpenBMC Documentation
Creative Commons Attribution 4.0 International
277 stars 307 forks source link

Add Gerrit server info to contributing doc #30

Closed anoo1 closed 8 years ago

anoo1 commented 8 years ago

Add steps to setup and push changes to the openbmc gerrit server.

Signed-off-by: Adriana Kobylak anoo@us.ibm.com


This change is Reviewable

amboar commented 8 years ago

Review status: 0 of 1 files reviewed at latest revision, 1 unresolved discussion.


contributing.md, line 109 [r1] (raw file):

<openbmc_repo> is the current git repository you're working on, such as
phosphor-rest-server:
`remote add gerrit ssh://your_github_id@openbmc.gerrit/openbmc/openbmc_repo`

Bit of a nit-pick, but this should be git remote add ...


Comments from Reviewable

amboar commented 8 years ago

Review status: 0 of 1 files reviewed at latest revision, 3 unresolved discussions.


contributing.md, line 107 [r1] (raw file):


From your openbmc git repository, add a remote to the gerrit server, where
<openbmc_repo> is the current git repository you're working on, such as

Don't forget that the markdown is rendered into HTML when viewed on github. If you look at[1] you'll see that the text '' is missing due to the angle brackets.

[1] https://github.com/openbmc/docs/blob/b0d149b2ce70c4b3db5a92dae9a5a7079532e912/contributing.md


contributing.md, line 116 [r1] (raw file):

`scp -p -P 29418 your_github_id@gerrit.openbmc-project.xyz:hooks/commit-msg ${gitdir}/hooks`

To submit a change set, push to the gerrit server, where <gerrit> is the name

Angle brackets again here.


Comments from Reviewable

amboar commented 8 years ago

Review status: 0 of 1 files reviewed at latest revision, 3 unresolved discussions.


contributing.md, line 107 [r1] (raw file):

Previously, amboar (Andrew Jeffery) wrote… > Don't forget that the markdown is rendered into HTML when viewed on github. If you look at[1] you'll see that the text '' is missing due to the angle brackets. > > [1] https://github.com/openbmc/docs/blob/b0d149b2ce70c4b3db5a92dae9a5a7079532e912/contributing.md >

Hah, turns out reviewable doesn't handle < or > properly either...


Comments from Reviewable

mdmillerii commented 8 years ago

I would suggest using single underscore on each end to render it in italics, and still be _readable_ in plane text.

williamspatrick commented 8 years ago

Per @kc8apf ...

We should add documentation on first time login. User needs to log into webUI first to get an account on Gerrit server. Also should go to https://gerrit.openbmc-project.xyz/plugins/github-plugin/static/account.html to ensure SSH keys are imported from Gerrit. Without these two steps, command line doesn't work.