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

Remove canonical URLs from demo metadata #1232

Merged
merged 10 commits into from
Oct 8, 2024

Conversation

Mandrenkov
Copy link
Collaborator

@Mandrenkov Mandrenkov commented Oct 7, 2024

Title:
Remove the canonicalURL field from demo metadata.

Summary:
This PR removes the canonicalURL field from existing demo metadata. The canonicalURL field has been superseded by the (autogenerated) slug field as of #1228.

Relevant references:
None.

Possible Drawbacks:
None.

Related GitHub Issues:
None.


Detailed Changes:

  1. Fixed the $id reference in demo.metadata.schema.0.1.3.json.
  2. Added demo.metadata.schema.0.1.4.json which removes the canonicalURL field.
  3. Updated the example metadata in demonstrations_metadata.md.
  4. Removed the canonicalURL field from existing demo metadata (and adjusted dateOfLastModification).
  5. Deleted the obsolete update_metadata.py script.

Merge Checklist:

  • Delete the "Build Website - Text (Test)" GHA workflow which was added for testing purposes.

Verification:

The generated metadata.json file in the Glass Onion bucket no longer has any canonicalURL fields:

metadata.json Snippet

[
  {
    "authors": [
      {
        "username": "whatsis"
      }
    ],
    "basedOnPapers": [],
    "categories": [
      "Quantum Computing",
      "How-to"
    ],
    "dateOfLastModification": "2024-10-07T00:00:00+00:00",
    "dateOfPublication": "2024-10-01T00:00:00+00:00",
    "doi": "",
    "previewImages": [
      {
        "type": "thumbnail",
        "uri": "/_static/demo_thumbnails/regular_demo_thumbnails/thumbnail_how_to_use_noise_models.png"
      },
      {
        "type": "large_thumbnail",
        "uri": "/_static/demo_thumbnails/large_demo_thumbnails/thumbnail_large_how_to_use_noise_models.png"
      }
    ],
    "referencedByPapers": [],
    "references": [],
    "relatedContent": [
      {
        "id": "tutorial_noisy_circuits",
        "type": "demonstration",
        "weight": 1
      }
    ],
    "seoDescription": "Learn how noise models can be built and inserted into a quantum circuit in PennyLane.",
    "slug": "tutorial_how_to_use_noise_models",
    "tags": [],
    "title": "How to use noise models in PennyLane"
  },
  ...
]

@Mandrenkov Mandrenkov added the ci:build-all-qml-demos Build all the Demos for this Pull Request label Oct 7, 2024

This comment was marked as outdated.

Copy link

github-actions bot commented Oct 7, 2024

Thank you for opening this pull request.

You can find the built site at this link.

Deployment Info:

  • Pull Request ID: 1232
  • Deployment SHA: 8ff896c72cca3a2526551e45491d829e67fbe68a
    (The Deployment SHA refers to the latest commit hash the docs were built from)

Note: It may take several minutes for updates to this pull request to be reflected on the deployed site.

@Mandrenkov Mandrenkov added do not merge and removed ci:build-all-qml-demos Build all the Demos for this Pull Request labels Oct 7, 2024
@Mandrenkov Mandrenkov marked this pull request as ready for review October 7, 2024 17:08
Copy link
Contributor

@doctorperceptron doctorperceptron left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link

@anthayes92 anthayes92 left a comment

Choose a reason for hiding this comment

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

Looks good with TODOs ⭐ One question about version number

@Mandrenkov Mandrenkov merged commit a87a0ae into master Oct 8, 2024
6 checks passed
@Mandrenkov Mandrenkov deleted the sc-72674-remove-canonical-url-from-metadata branch October 8, 2024 17:51
@Mandrenkov Mandrenkov mentioned this pull request Oct 9, 2024
Mandrenkov added a commit that referenced this pull request Oct 9, 2024
**Summary:**
Fixes a merge conflict between `master` and `dev` introduced by #1232
(due to divergent `dateOfLastModification`).

To reproduce this PR:
1. Run `git checkout dev`.
2. Run `git checkout -b merge-master-into-dev`.
3. Run `git merge master`.
4. Accept all incoming changes for merge conflicts on
`dateOfLastModification`.

**Relevant GHA Workflow Runs:**
* https://github.com/PennyLaneAI/qml/actions/runs/11241666164
* https://github.com/PennyLaneAI/qml/actions/runs/11253088983

---------

Co-authored-by: David Wierichs <[email protected]>
Co-authored-by: Korbinian Kottmann <[email protected]>
Co-authored-by: Ivana Kurečić <[email protected]>
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