-
Notifications
You must be signed in to change notification settings - Fork 48
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
Restored topics structure #61
Restored topics structure #61
Conversation
Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
To review, it's probably best to try to brows the repo in github's web interface here on my branch: https://github.com/zuiderkwast/valkey-doc/blob/restored-topics-structure/topics/introduction.md The idea is that the links should work. (Previously they only worked in the rendered website.) This purpose is to make it easier for doc contributors and to make the docs more self-contained. |
Details about renamed/moved files and updated links within the files. Moved files
Changed links
|
Here is the Perl script. (Sorry, Perl is my native language for this kind of tasks. 😁) move-files-fix-links.pl
(If you want to try it, first |
Personally, I think we can merge this and get the website up. Then we can update it regularily later. The longer this kind massive (but somehow trivial) changes wait, the more merge conflicts and other trouble for this and other PRs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I scanned through the files and it looks like what you say, so I'm going to just approve it.
Although that Perl is gnarly and I never want to see it again @zuiderkwast ;) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just looked at the commits and the approach.
Awesome, thanks! Should we keep the individual commits? It makes it easier to see what's moved in one commit. (I can enable rebase-and-merge temporarily.) |
Squash-merged. It's possible to go back to this PR to see each commit, if anyone ever wants to do that. |
### Description 1. Updates the docs submodule 2. changes the structure to reflect the flat `/topic/...` structure adopted in valkey-io/valkey-doc#61 ### Issues Resolved n/a ### Check List - [x] Commits are signed per the DCO using `--signoff` By submitting this pull request, I confirm that my contribution is made under the terms of the BSD-3-Clause License. --------- Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>
This massive change restores the
topics/page.md
structure of the doc repo, as it was a few years ago.It my not make sense to review this manually. If you do, you probably want to review one commit at a time. Renaming the files is done in one commit. Fixing the links is done in another commit.
This is done using a script that I can share. This is what it does:
docs/getting-started/installation/install-redis-from-source.md
->topics/install-valkey-from-source.md
.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.Fixes #30