-
Notifications
You must be signed in to change notification settings - Fork 30
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
Add documentation about JSS #36
Conversation
c70c133
to
d6ca0d1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have 2 comments regarding CI docs. Thank you!
docs/CI.md
Outdated
@@ -0,0 +1,24 @@ | |||
# Containers and Continuous Integration | |||
|
|||
JSS uses [Travis CI](https://travis-ci.com/about) for PR gating. We use |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about adding the Travis link to repo instead of about? https://travis-ci.org/dogtagpki/jss
docs/CI.md
Outdated
[Podman docs](https://github.com/containers/libpod/tree/master/docs). | ||
|
||
To skip running CI for a given commit (e.g., for updating documentation), | ||
append `[skip ci]` to the commit summary. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about adding a note something like "Even though test runs against ubuntu
, the final build results are considered Success
even if ubuntu
build fails"? This will avoid the user from assuming that the CI has bugs when a user sees a X mark against ubuntu but still his/her PR passes. Your thoughts?
d6ca0d1
to
32581a6
Compare
@SilleBille These comments should now be addressed, thanks! |
32581a6
to
dcb297d
Compare
- Different interfaces with the build system - Environment variables recognized by the build system Signed-off-by: Alexander Scheel <ascheel@redhat.com>
dcb297d
to
5e18907
Compare
Signed-off-by: Alexander Scheel <ascheel@redhat.com>
Signed-off-by: Alexander Scheel <ascheel@redhat.com>
5e18907
to
f4913ab
Compare
Signed-off-by: Alexander Scheel <ascheel@redhat.com>
This now includes documentation on the new Merging as it is now complete and has been spellchecked. Further documentation can be added or revised later. |
This is the initial step in improving documentation about JSS. In particular, this PR documents two aspects:
The latter is important as 389-console appears to be using JSS without including
slf4j-api.jar
in the classpath.