-
Notifications
You must be signed in to change notification settings - Fork 158
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 missing docs artifacts (to fix docs styling) #1839
Add missing docs artifacts (to fix docs styling) #1839
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.
On reflection I have decided that I don't like the JIRA IDs in the commit subject. This is not something the general community has access to, so please rewrite the commit subjects to not have them. JIRA IDs could be in the body of the commit, if desired.
Please consider spot-checking the links in the _static files, as I have found one invalid one there may be more and it appears that they are not something that linkcheck can identify.
I haven't tested it much, but apparently we can trigger JIRA integration with things like the branch name (which you're already doing) or the name of the PR. So any working spot is fine, I just don't want the JIRA ID in the first line of the commit - that is prime real estate and what we look at often when reviewing git history. We won't remember what FR-1234 maps to, but if the first line has interested me enough to read the full commit, then FR-1234 is interesting. |
Ack. I was going by the suggestion provided by JIRA, though I didn't like it much myself :) |
@dbungert Just to clarify: Would you like to have the JIRA issue reference added in the commit msg on the second (or later) line, or is that optional? |
7f01318
to
0204b31
Compare
If you just want to tie the PR to the card, I think the branch name - like you're already doing - is a good spot. If you think the commit is likely to be referenced later and there is some detailed information in the card, then that would be good to reference in the body of the commit message, but I see this as optional. This would also seem to satisfy tying the PR to the card. |
Fixes FR-5688
doc/.gitignore
file which prevented docs artifacts from being included in commits (yeah, silly me).