Skip to content

Commit a9ba2ea

Browse files
smackeseycmpadden
andauthored
[docs] Snippet graveyard to hold references to old snippets (#27567)
## Summary & Motivation Add a "snippet graveyard" unlisted docs file to hold references to snippets that are no longer referenced in the docs. This is to avoid a problem when building versioned docs wherein: * master and versioned docs need to build * when building, they reference an index from snippet names to functions * the set of keys in that index is built by scanning master * therefore if all references to an older snippet is removed in master, it will disappear from the index * causing the versioned doc build to fail because it can’t find the snippet it still references in the index This snippet graveyard file (and perhaps the old snippet files too) should be removed immediately once a solution is found to the above problem. ## How I Tested These Changes Built docs --------- Co-authored-by: Colton Padden <colton@dagsterlabs.com>
1 parent b162b2e commit a9ba2ea

File tree

6 files changed

+19
-0
lines changed

6 files changed

+19
-0
lines changed

docs/content/api/modules.json.gz

2.95 KB
Binary file not shown.
518 Bytes
Binary file not shown.

docs/content/api/sections.json.gz

1.96 KB
Binary file not shown.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Snippet graveyard"
3+
sidebar_position: 200
4+
unlisted: true
5+
---
6+
7+
This exists purely to retain snippet references to no longer used snippets,
8+
which is necessary to allow versioned docs to build. It is a temporary measure.
9+
10+
<CodeExample path="docs_beta_snippets/docs_beta_snippets/guides/components/deployments/12-workspace.yaml" language="YAML" title="my-deployment/workspace.yaml" />

docs/next/public/objects.inv

274 Bytes
Binary file not shown.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
load_from:
2+
- python_file:
3+
relative_path: code_locations/code-location-1/code_location_1/definitions.py
4+
location_name: code_location_1
5+
executable_path: code_locations/code-location-1/.venv/bin/python
6+
- python_file:
7+
relative_path: code_locations/code-location-2/code_location_2/definitions.py
8+
location_name: code_location_2
9+
executable_path: code_locations/code-location-2/.venv/bin/python

0 commit comments

Comments
 (0)