#6665 Update wiki page with new bodhi CLI options
Closed: Fixed 6 years ago Opened 7 years ago by dustymabe.

With the new bodhi CLI this wiki page is out of date:

https://fedoraproject.org/wiki/Bodhi/BuildRootOverrides


Metadata Update from @puiterwijk:
- Issue tagged with: easyfix

7 years ago

It would be good to document this in Bodhi's docs. We could add a new page here for BROs:

https://github.com/fedora-infra/bodhi/tree/develop/docs/user

Then we could link to that from the Wiki.

Also, there is a bodhi man page that describes how to use the CLI:

https://bodhi.fedoraproject.org/docs/man_pages/bodhi.html

It is shipped with the Bodhi CLI, so it can also be viewed with man bodhi.

Hello. I would like to take this up. Is there any guide on how to write for the wiki. Thanks

@wesleyotugo I don't know if there's a guide about writing for the wiki - as long as you are in a FAS group outside of the CLA groups you should be able to click edit after logging in.

I still recommend adding these docs in Bodhi's own documentation. I'm not sure if others agree with that, but IMO it would be best to upstream the non-Fedora specifics there. The Wiki can link to it, and add any info that might be specific to Fedora's settings or policies.

Those docs can be added here: https://github.com/fedora-infra/bodhi/tree/develop/docs/user

@bowlofeggs I asked because I thought Fedora wiki was not a traditional wiki but more of a Community wiki i.e used for planning and documenting fedora communities activities. I read somewhere that about @mattdm 's whiteboard analogy." The wiki is, generally, best used for material you'd write on a whiteboard in a meeting room. You realize it might get erased by the next meeting or the cleaning staff. Don't put durable reference documents in the wiki."

+1 for a link to bodhi's documentation.

Any final decision on how this should be handled?

Lets update the wiki page with a link to bodhi's documentation. It will be easier to keep bodhi's documentation up to date than the wiki.

@wesleyotugo Yeah I agree. Bodhi's docs don't yet have much about Buildroot Overrides in general, but it does have CLI docs for managing them that way:

https://bodhi.fedoraproject.org/docs/user/man_pages/bodhi.html#overrides

It would be good to write a page in Bodhi's docs that explains BROs for users too.

I wrote some simple documentation about buildroot overrides for Bodhi:

https://github.com/fedora-infra/bodhi/pull/2198

So is this done? Or do we still need to get the wiki page to point to the bodhi docs?

Metadata Update from @kevin:
- Issue priority set to: Waiting on Reporter

7 years ago

@kevin I don't think it's done - the BRO docs aren't live at https://bodhi.fedoraproject.org/docs yet (I think they were included in the 3.6.0 deployment, but we had to roll that back due to $issues.)

Once they are live we can edit the wiki to reference them.

Sorry I had an internship and offline work that held me down. Sorry for the lack of report on this

No worries. I went ahead and adjusted the wiki page and added fedpkg there also.

Please do look it over and improve it!

Thanks everyone.

Metadata Update from @kevin:
- Issue close_status updated to: Fixed
- Issue status updated to: Closed (was: Open)

6 years ago

On 07/25/2018 04:03 PM, Kevin Fenzi wrote:

Please do look it over and improve it!

Thanks Kevin, looks good!

Log in to comment on this ticket.

Metadata