Improve the metadata for each page #131
Comments
Eric-Arellano
changed the title
javabster
added a commit
that referenced
this issue
Nov 16, 2023
closes #131 --------- Co-authored-by: abbycross <across@us.ibm.com>
github-merge-queue bot
pushed a commit
that referenced
this issue
Dec 11, 2023
Closes #200. Note that we still want to improve this metadata checker to also start checking some quality things, like that it's <160 characters. But this is a good first pass. See #327. ``` Invalid Jupyter notebook metadata. Every .ipynb file needs to set 'title' and 'description' in the file metadata. You need to manually add this metadata. For example, if using VSCode, open up the file with the "Open With..." option and then "Text Editor". Once the file is open in text-mode, scroll down to the bottom of the file for the top-level key "metadata". Be careful that this is the metada for the entire file and not a single code block. You should see in the "metadata" section other entries like "language_info" and "nbconvert_exporter". Finally, add new keys in the "metadata" section for "title" and "description". The "title" should be the page title; the "description" should describe the page in <160 characters, ideally using some keywords. The description is what shows up on Google results. See #131 for some tips. For example: "metadata": { "description": "Get started using Qiskit with IBM Quantum hardware in this Hello World example", "title": "Hello world", "celltoolbar": "Raw Cell Format", "kernelspec": { ... } Please fix these files: docs/start/hello-world.ipynb ``` ``` Invalid markdown file metadata. Every .md and .mdx file should start with a metadata block like this: --- title: Representing quantum computers description: Learn about coupling maps, basis gates and backend errors for transpiling --- The title should be the page title; the description should describe the page in <160 characters, ideally using some keywords. The description is what shows up on Google results. See #131 for some tips. Please fix these files: docs/start/setup-channel.mdx ``` --------- Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this issue
Jul 22, 2024
closes Qiskit#131 --------- Co-authored-by: abbycross <across@us.ibm.com>
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this issue
Jul 22, 2024
Closes Qiskit#200. Note that we still want to improve this metadata checker to also start checking some quality things, like that it's <160 characters. But this is a good first pass. See Qiskit#327. ``` Invalid Jupyter notebook metadata. Every .ipynb file needs to set 'title' and 'description' in the file metadata. You need to manually add this metadata. For example, if using VSCode, open up the file with the "Open With..." option and then "Text Editor". Once the file is open in text-mode, scroll down to the bottom of the file for the top-level key "metadata". Be careful that this is the metada for the entire file and not a single code block. You should see in the "metadata" section other entries like "language_info" and "nbconvert_exporter". Finally, add new keys in the "metadata" section for "title" and "description". The "title" should be the page title; the "description" should describe the page in <160 characters, ideally using some keywords. The description is what shows up on Google results. See Qiskit#131 for some tips. For example: "metadata": { "description": "Get started using Qiskit with IBM Quantum hardware in this Hello World example", "title": "Hello world", "celltoolbar": "Raw Cell Format", "kernelspec": { ... } Please fix these files: docs/start/hello-world.ipynb ``` ``` Invalid markdown file metadata. Every .md and .mdx file should start with a metadata block like this: --- title: Representing quantum computers description: Learn about coupling maps, basis gates and backend errors for transpiling --- The title should be the page title; the description should describe the page in <160 characters, ideally using some keywords. The description is what shows up on Google results. See Qiskit#131 for some tips. Please fix these files: docs/start/setup-channel.mdx ``` --------- Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Specifically the
titleanddescription. We want better SEO and social media sharing.In MDX, this is at the top of the file:
documentation/docs/support.mdx
Lines 1 to 3 in c0b5533
In notebooks, it's in the file's
metadatasection, which is much easier to miss:documentation/docs/build/backend_reset.ipynb
Lines 770 to 771 in c0b5533
The title is used for the browser tab's title and for the SEO and social media title. Description is used for SEO and social media. Best practices to follow for the description:
Hadamon Gate, quantum computing, Qiskit, Runtime, transpileis a bad description. It should read naturally. Reminder the description is used for rich previews on social media & the Google result.The text was updated successfully, but these errors were encountered: