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

docs(weaver): Fixed broken links in, and referring to, Weaver RFCs #2522

Merged
merged 1 commit into from
Jun 28, 2023
Merged

Conversation

VRamakrishna
Copy link
Contributor

The Weaver RFCs (weaver/rfcs/) contain several cross-specification links as relative paths rather than absolute URLs.
Some RFCs are also referenced in other parts of the weaver code.
The last refactoring of the weaver/rfcs/ folder resulted in several broken links. This PR identifies and fixes those links.

Copy link
Contributor

@petermetz petermetz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@VRamakrishna LGTM, but a small nit-pick is that I'd say docs(weaver): fix broken links in, and referring to, Weaver RFCs because in the release the "fix" prefixed commits will show up in the "Bug-fixes" section of the release notes and the readers of those documents are people who are trying to decide if they should upgrade their existing production deployments to the newer version or not and to them the documentation fixes (even they ARE fixes in my opinion as well) are not useful info because they are interested in seeing the bug-fixes the code that is running on their servers has received.

Approving it anyway because it's a small thing, but I figured at least I'll write this down here so that you are aware of how the release notes/changelog.md file generation works based on the commit messages.

@VRamakrishna VRamakrishna changed the title fix(weaver): Fixed broken links in, and referring to, Weaver RFCs docs(weaver): Fixed broken links in, and referring to, Weaver RFCs Jun 28, 2023
@VRamakrishna
Copy link
Contributor Author

@petermetz Fixed the title.

@petermetz
Copy link
Contributor

@petermetz Fixed the title.

@VRamakrishna Thank you! The PR title looks good, but it does not automatically sync to the commit subject unfortunately (which is still the old one)

@VRamakrishna
Copy link
Contributor Author

@petermetz Sorry for my misunderstanding. I've amended the commit and pushed again.

Signed-off-by: VRamakrishna <vramakr2@in.ibm.com>
@petermetz petermetz enabled auto-merge (rebase) June 28, 2023 22:33
@petermetz petermetz merged commit 7097ec0 into hyperledger-cacti:main Jun 28, 2023
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.

3 participants