Refactor release notes handling of separate pages #1305
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
No other changes made.
Before, we were checking if it was Qiskit. But we should be consistent for all packages that have separate release notes.
It was redundant to have both. Now, we have a method hasSeparateReleaseNotes() that dynamically computes the value
This will soon have the additional kwarg `enabled`. The class is nice because it allows us to have default args and to group related config options into a single place.
Before, we required that you specify the version & the URL for the entry. But the full URL is only necessary in generateToc.ts, which already has the prefix for the URL. It's much simpler if instead we only pass the version strings.
|
Each commit is distinct and has some description attached to it. I recommend reviewing by commit |
frankharkins
approved these changes
May 7, 2024
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
This is a prefactor for the upcoming addition of the Cloud Transpiler. It does not yet have release notes, so we need to be able to disable the mechanism.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a prefactor for the upcoming addition of the Cloud Transpiler. It does not yet have release notes, so we need to be able to disable the mechanism.