Move files and fix links #30
Assignees
Comments
This was referenced Apr 19, 2024
Merged
zuiderkwast
added a commit
that referenced
this issue
Apr 24, 2024
This massive change restores the `topics/page.md` structure of the doc repo, as it was a few years ago. This is done using a script that is shared in the PR in a comment. This is what it does: 1. The "aliases" metadata field in each markdown file is used to find the original "topics" filename. This is attempted for all files in the repo with a metadata section. 2. For files that don't have a "topics/" alias, pick a topics name for it, like this: * Do this only for files under "docs/". * If the file path matches "..../NAME/_index.md", the new name is "topics/NAME.md" * Otherwise, the file path matches "..../NAME" and then the new name is "topics/NAME". (This case covers png files and other non-markdown files too.) * If the filename includes 'redis', this is replaced by 'valkey'. Examples: `docs/getting-started/installation/install-redis-from-source.md` -> `topics/install-valkey-from-source.md` * (Special case: If the target file name ends up "topics.md", use "topics/index.md" instead.) 3. Rename the files to the new names. Commit the the renames. 4. Update all links to files (renamed and not renamed), using all aliases discovered using all files with a metadata section. * The links are changed to relative links including the `.md` suffix. This makes it possible to click around in the github web interface. It's also good in other situations. For example, users can deploy the docs (simply .md -> .html) and don't need to deploy the docs in the root directory. * Examples: * Change link: /docs/reference/cluster-spec => cluster-spec.md (in topics/protocol.md) * Change link: /topics/acl => ../topics/acl.md (in commands/auth.md) Additional changes: * Fix broken link in cluster tutorial * Remove some stub files with no real content (commands/_index.md, resources/_index.md) Fixes #30 --------- Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Until a few years ago, the documentation was mainly written by Salvatore and had a simple structure with URLs on the form "/topics/pagename" for all pages except commands. This is how it used to look like until some time in the beginning of 2022: https://web.archive.org/web/20211216094009/https://redis.io/documentation
We've decided (in a core team meeting) to restore this structure. It gives back a feeling from the good times. There are still many links to these URLs in places like comments inside valkey.conf, the module API docs in module.c and other places, so it's a bonus that these links will work again.
I'm working on a script to rename the files and to fix the links within the repo. I'm opening this issue and assigning myself mainly to show what I'm working on. Some minor questions though:
../commands/hget.mdinstead of/commands/hget). This would make it possible to click on the links in the GitHub pages in the valkey-doc repo. Is this OK?/commands/?group=sorted-set, i.e. links to commands categories? Shall we generate static pages for each of these groups or should we instead generate links like/commands/#sorted-setand do the filtering on the browser side? The command index page could even be a static page with anchored headings for each command group. WDYT?@stockholmux
The text was updated successfully, but these errors were encountered: