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

Doc: add change history to documentation (Infra) #750

Merged
merged 3 commits into from
Oct 9, 2023
Merged

Conversation

tang-mm
Copy link
Collaborator

@tang-mm tang-mm commented Sep 28, 2023

Description

Add a change history page in the Checkbox reference docs, containing a link to the GitHub Releases page.

This initial version of change history is a copy of the GitHub-generated release notes. With the implementation of PR title validation, further changes to this page should be improved into an integrated action within the release process.

Resolved issues

CHECKBOX-846

Documentation

Tests

  1. In the docs/ folder, build the documentation set locally by running:
$ make install
$ make run
  1. Go to http://127.0.0.1:8000/reference/changes

Copy link
Contributor

@yphus yphus left a comment

Choose a reason for hiding this comment

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

tested locally, the changelog renders very well, thx.

@tang-mm
Copy link
Collaborator Author

tang-mm commented Sep 28, 2023

appended a commit to fix spelling check errors

@tang-mm tang-mm requested a review from yphus September 28, 2023 10:16
Copy link
Contributor

@kissiel kissiel left a comment

Choose a reason for hiding this comment

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

Some of the lines you've added don't end with a blank space, and from what I can tell, the existing ones do. I pointed out one easy to spot below.
I'd like to know if there's a reason to have them, if not, I'll gladly trim all of them.

docs/.sphinx/wordslist.txt Outdated Show resolved Hide resolved
@tang-mm
Copy link
Collaborator Author

tang-mm commented Oct 9, 2023

Following the discussion in MM, the initial changelog only contains a link for consistency and maintenance purposes. Further content should be generated through automation in the release process.

(removed docs/.wordlist.txt because it is replaced by docs/sphinx/wordlist.txt)

Copy link
Collaborator

@Hook25 Hook25 left a comment

Choose a reason for hiding this comment

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

Ty for the contribution and removing that old wordlist as well

@Hook25 Hook25 merged commit c670364 into main Oct 9, 2023
7 checks passed
@Hook25 Hook25 deleted the add-changelog-doc branch October 9, 2023 09:31
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.

4 participants