fm-orchestrator

Clone
Source Code
GIT

#163 Update README
Closed: Fixed 6 years ago Opened 7 years ago by ralph.

Closed: Fixed
Reopen Issue

As a developer interested in contributing to Rida, I would like to learn more about how Rida works and how I can contribute. I will need an update to the documentation to better understand Rida and its features.

Some examples to consider:

  • HTTP response codes (HTTP 401 seems to be missing -- maybe there are more?)
    Explanation of how submit-build.sh is used to submit a build (authentication and all that)
  • Examples of how/why a module build can fail
  • Update to URLs -- e.g., HTTP GET should be /rida/1/module-builds/ instead of /rida/module-builds/

We've changed the README a lot recently, but I think it would still be worth going over it with an eye explaining how things work to new developers.

@fivaldi - Have you looked at this recently? Are things sufficiently documented? Can we close this, or does it still need more work?

Metadata Update from @fivaldi:
- Issue assigned to fivaldi
6 years ago

Metadata Update from @fivaldi:
- Issue close_status updated to: Fixed
6 years ago

See PR#648

Metadata Update from @fivaldi:
- Issue status updated to: Open (was: Closed)
6 years ago

Metadata Update from @fivaldi:
- Issue close_status updated to: Fixed
6 years ago

Login to comment on this ticket.

Metadata
None
None
None
Powered by Pagure 5.13.3
Documentation • File an Issue • About • SSH Hostkey/Fingerprint
© Red Hat, Inc. and others.