Skip to content

Commit 978f042

Browse files
committed
add disclaimer to gists about gist-ids
1 parent fdffbff commit 978f042

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

docs/reference/gist.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,19 @@ This is done using the `github/gist` backup type in your configuration file,
44
along with an appropriate `from` directive to define the source of the gists
55
you wish to back up.
66

7+
::: note
8+
GitHub Gists don't have explicit "names" — instead, they are identified by a unique *gist ID*.
9+
While GitHub displays a filename as the Gist name in the UI, it's actually just the name of the
10+
*first* file in the Gist, which can change over time.
11+
12+
When backing up a Gist, the repository name will be based on the stable gist ID rather than a
13+
filename. This avoids issues where users rename files or add new ones, which could otherwise
14+
result in the same Gist being backed up multiple times under different names.
15+
16+
If you choose to back up GitHub Gists, be aware that the resulting repositories will be named
17+
using their gist ID rather than the more human-readable names shown on the GitHub website.
18+
:::
19+
720
## Examples
821
The following examples show how you can combine the `kind` and `from` directives
922
to back up gists from GitHub.

0 commit comments

Comments
 (0)