Skip to content
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

Merged
merged 4 commits into from
Oct 10, 2018
Merged

Conversation

cipherboy
Copy link
Member

This is the initial step in improving documentation about JSS. In particular, this PR documents two aspects:

  • The build system and the various parts of it. It will be expanded as more information is acquired.
  • Using JSS in an external project. This documents the CLASSPATH dependencies of JSS.

The latter is important as 389-console appears to be using JSS without including slf4j-api.jar in the classpath.

@cipherboy cipherboy changed the title Add documentation about JSS [WIP] Add documentation about JSS Oct 10, 2018
Copy link
Member

@SilleBille SilleBille left a 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
Copy link
Member

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.
Copy link
Member

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?

@cipherboy
Copy link
Member Author

@SilleBille These comments should now be addressed, thanks!

@cipherboy cipherboy changed the title [WIP] Add documentation about JSS Add documentation about JSS Oct 10, 2018
 - Different interfaces with the build system
 - Environment variables recognized by the build system

Signed-off-by: Alexander Scheel <ascheel@redhat.com>
Signed-off-by: Alexander Scheel <ascheel@redhat.com>
Signed-off-by: Alexander Scheel <ascheel@redhat.com>
@cipherboy cipherboy added docs Changes related to documentation CI Changes related to the CI system or Dockerfiles labels Oct 10, 2018
@cipherboy cipherboy added this to the 4.5.1 milestone Oct 10, 2018
Signed-off-by: Alexander Scheel <ascheel@redhat.com>
@cipherboy
Copy link
Member Author

This now includes documentation on the new gh-pages branch for https://pagure.io/jss/issue/24.

Merging as it is now complete and has been spellchecked. Further documentation can be added or revised later.

@cipherboy cipherboy self-assigned this Oct 10, 2018
@cipherboy cipherboy merged commit 5b381b8 into dogtagpki:master Oct 10, 2018
@cipherboy cipherboy deleted the documentation branch January 7, 2020 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Changes related to the CI system or Dockerfiles docs Changes related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants