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 missing docs artifacts (to fix docs styling) #1839

Merged
merged 2 commits into from
Oct 18, 2023

Conversation

rkratky
Copy link
Collaborator

@rkratky rkratky commented Oct 13, 2023

Fixes FR-5688

  • Fixes the unchecked greediness of the doc/.gitignore file which prevented docs artifacts from being included in commits (yeah, silly me).
  • Adds the required artifacts.

Copy link
Collaborator

@dbungert dbungert left a 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.

doc/.sphinx/_static/favicon.png Outdated Show resolved Hide resolved
doc/.sphinx/_templates/footer.html Show resolved Hide resolved
@dbungert
Copy link
Collaborator

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.

@rkratky
Copy link
Collaborator Author

rkratky commented Oct 18, 2023

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.

Ack. I was going by the suggestion provided by JIRA, though I didn't like it much myself :)

@rkratky
Copy link
Collaborator Author

rkratky commented Oct 18, 2023

@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?

@rkratky rkratky force-pushed the FR-5688_add-missing-artifacts branch from 7f01318 to 0204b31 Compare October 18, 2023 12:37
@dbungert
Copy link
Collaborator

@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?

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.

@dbungert dbungert merged commit 65da507 into canonical:main Oct 18, 2023
@rkratky rkratky deleted the FR-5688_add-missing-artifacts branch October 19, 2023 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants