Improve instructions for metadata check for notebooks #200
Comments
|
Alternative: automate this as part of #131. It's awkward to manually set metadata for notebooks. Have a script that will do this, and that facilitates reading what the value is. |
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 <[email protected]>
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 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Explain how to do it
The text was updated successfully, but these errors were encountered: