-
Notifications
You must be signed in to change notification settings - Fork 414
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
RATIS-843: create ratis-docs module #59
Conversation
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.
Thank you very much @esahekmat
I think documentation is very important and I am very grateful that it's started.
The change looks good to me, but would you be so kind to update LICENSE.txt with the new information.
I assume that the doc will be part of the source release, so we need to add it to the LICENSE.txt
Sg. like this:
The product bundles Bootstrap in ratis-docs/themes/ratisdoc/static/ which is licensed under <LICENSENAME>
<COPY FULL LICENSE TO HERE>
This should be done for all the included components (bootstrap, jquery, glyphicons?)
As I know (but please check) the glyphicons fonts have the same license as the bootstrap when they are used together with the bootstrap. But if they have any specific copyright lines at the beginning of the MIT, we should copy full license.
@elek why this merge request hasn't merged yet? does it have any problem? |
Because the Easter Holidays in Europe ;-) I am checking it right now, apologize for the delay... |
Sorry, I think there is a problem related to this PR |
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.
No worries. And thanks the update. Looks good to me.
I think you close this PR instead of merging it. |
I merge the commits locally because I prefer to sign the commits (which is not possible with the merge buttons). To have a reference between the PR I added an additional text to the commit message ("Closes #843") which closes the the PR automatically when I push the commit to the master. If you click to the 2c8d550 commit from the previous message you can see that it's on the master. This can be confusing, but the commits are signed ;-) (The same are explained here: https://cwiki.apache.org/confluence/display/HADOOP/Using+Github+for+Ozone+development) But I can make mistakes easily (usually I do), so feel free to ping me if the commit is missing from the master. In this case seems to be there. |
create a base structure for the project documentation