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

adding cell metadata for extraction into docs #91

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Blackmist
Copy link

Description

Adds metadata tag named "name" to code cells. Tags allow us to extract code cells into documentation, meaning docs can always pull from the sample as the single source of truth.

Checklist

  • [ x ] I have read the contribution guidelines
  • [ x ] I have coordinated with the docs team ([email protected]) if this PR deletes files or changes any file names or file extensions.
  • [ x ] This notebook or file is added to the CODEOWNERS file, pointing to the author or the author's team.

@Blackmist Blackmist requested a review from a team as a code owner June 6, 2024 17:29
Copy link
Collaborator

@kdestin kdestin left a comment

Choose a reason for hiding this comment

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

We currently strip out all metadata from notebooks. We would need to make an exception for that specific field for CI to pass.

@@ -35,7 +35,9 @@
"cell_type": "code",
"execution_count": null,
"id": "84916e91",
"metadata": {},
"metadata": {
"name": "subscription"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Could "name" be changed to be more descriptive (e.g. Azure-Docs-Code-Sample)?

Copy link
Author

Choose a reason for hiding this comment

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

@kdestin Unfortunately no. The docfx publishing system we use for docs.microsoft.com looks for the "name" tag. It'd take a feature request to the platform team to change it. The value of that tag has to be unique and can be whatever.

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.

2 participants