Fix previous releases sidebar feature for ecosystem projects #267
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
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
github-merge-queue bot
pushed a commit
to qiskit-community/qiskit-experiments
that referenced
this pull request
Apr 18, 2023
### Summary The previous releases section on the documentation sidebar includes the current version (0.5), which is unnecessary. The link is also broken right now (will be fixed in Qiskit/qiskit_sphinx_theme#267), which is another motivation to remove this from the current docs. This PR changes the list so the current version won't be included.
mergify bot
pushed a commit
to qiskit-community/qiskit-experiments
that referenced
this pull request
Apr 18, 2023
### Summary The previous releases section on the documentation sidebar includes the current version (0.5), which is unnecessary. The link is also broken right now (will be fixed in Qiskit/qiskit_sphinx_theme#267), which is another motivation to remove this from the current docs. This PR changes the list so the current version won't be included. (cherry picked from commit d12fb7b)
javabster
reviewed
Apr 25, 2023
There was a problem hiding this comment.
I think the javascript in this PR should be extracted out into it's own module for re-usability in future. We could have a general utils.js file where we keep little js functions like this that we might want to use for other things and also do some proper automated testing on them
…into previous-versions-fix
Eric-Arellano
changed the title
Eric-Arellano
changed the title
Eric-Arellano
added a commit
that referenced
this pull request
Apr 27, 2023
Prework for #208. Abby and I decided that we want Jest tests for two purposes: 1. Checking that web components are in sync between the Pytorch and Furo themes, e.g. we didn't forget to update one of the folders. 1. We could do this either by using Snapshot testing or by simply checking that the file contents are equal. 2. We have some non-trivial logic in #267 and want to write automated unit tests. This PR adds the basic infrastructure, like setting up CI to install Node.js. That will make it easier to review follow-up PRs that add actual tests. > We could do this either by using snapshot testing I think we'd benefit from adding snapshot testing for the top nav bar rendering correctly. I want to do this in a follow up PR so we can properly decide if we want to add snapshots or not; the decision to use snapshots is separate from whether to use Jest generally.
…into previous-versions-fix
Eric-Arellano
changed the title
1ucian0
reviewed
Apr 28, 2023
…into previous-versions-fix
Eric-Arellano
commented
May 3, 2023
There was a problem hiding this comment.
Copy and paste of the Furo file. The Jest test is set up to ensure that the tests pass for both Furo and Pytorch.
We aren't testing that the file contents are identical between Furo and Pytorch because we may want utils.js to diverge. For example, maybe we add a util to Furo that is not needed for Pytorch.
This was referenced May 5, 2023
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.
Closes #235. As summarized in #235 (comment), we were only handling Terra properly.
I used test driven development to ensure I handled all the edge cases.
Leverages ecosystem redirects
We are now successfully redirecting ecosystem projects, e.g.
documentation/experiments/toecosystem/experiments. That simplifies the edge cases we need to handle: we only need to handle Terra (documentation/) and Ecosystem (ecosystem/<project>).Adds
utils.jsfileHaving a dedicated JavaScript file for our logic will make it easier to find all our custom logic. It also allows us to test the contents with Jest.