diff --git a/scripts/commands/checkMetadata.ts b/scripts/commands/checkMetadata.ts index a3fc7af1890..64e2ccb91b1 100644 --- a/scripts/commands/checkMetadata.ts +++ b/scripts/commands/checkMetadata.ts @@ -76,10 +76,13 @@ const main = async (): Promise => { Invalid markdown file metadata. Every .md and .mdx file should start with a metadata block like this: --- - title: OpenQASM 3 feature table - description: A list of the OpenQASM 3 language features + title: Representing quantum computers + description: Learn about coupling maps, basis gates, and backend errors for transpiling --- + The title should be the page title: it's used for browser tabs and the top line of search results. The description should describe the page + in <160 characters, ideally using some keywords. The description is what + shows up as the text in search results. See https://github.com/Qiskit/documentation/issues/131 for some tips. Please fix these files: ${mdErrors} `); @@ -87,7 +90,33 @@ const main = async (): Promise => { if (notebookErrors.length > 0) { console.error(` Invalid Jupyter notebook metadata. Every .ipynb file needs to - set 'title' and 'description' in the file metadata. + 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 metadata 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: it's used for browser tabs + and the top line of search results. The description should describe the page + in <160 characters, ideally using some keywords. The description is what + shows up as the text in search results. See + https://github.com/Qiskit/documentation/issues/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: ${notebookErrors} `);