quire-docs icon indicating copy to clipboard operation
quire-docs copied to clipboard

V1 Docs: Rename Select .md files - GLOBAL

Open Erin-Cecele opened this issue 3 years ago • 5 comments

Before proceeding, check to make sure there isn’t an existing issue for your suggestion or a similar one.

  • [X] I have searched the existing issues and determined this is new suggestion.

Idea being proposed

Rename Get Started from getting-started.md to get-started.md for consistency Rename YAML & Markdown yaml-markdown.md because calling it fundamentals.md is hard to find and confusing Rename Pages Types & Structure page-types.md because just pages.md is also a little confusing

Also make sure to change the affiliated page links throughout V1 docs (I think it's ok to leave as is in V0 docs)

What contribution category does your proposal fall under?

Copyedit text

Supporting Information

No response

Erin-Cecele avatar Aug 17 '22 21:08 Erin-Cecele

@geealbers - here is the list

Erin-Cecele avatar Aug 31 '22 19:08 Erin-Cecele

The list didn't come through. However, I think I also figured out how to handle redirects, using Hugo's Aliases: https://gohugo.io/content-management/urls/#aliases. So you could go ahead and do it at the same time you rename the files.

The short version is, you add any old URLs under an aliases key in the frontmatter of the newly named file. For example:

title: Markdown & YAML
aliases:
  - /documentation/fundamentals/

geealbers avatar Aug 31 '22 20:08 geealbers

@geealbers Am I just renaming in V1 docs or V0 docs as well?

Erin-Cecele avatar Aug 31 '22 21:08 Erin-Cecele

Hmm, not sure. I guess maybe leave v0 as is, just so it's a few less changes? But it would be good to use the aliases functionality to address the change of links from /documentation/ to /docs-v0/.

geealbers avatar Aug 31 '22 21:08 geealbers