Move old /docs to /docs/legacy (leaving references)#2328
Merged
Conversation
aa3840d to
75021cb
Compare
Contributor
|
What is the long-term plan for the wire-server docs? If we want to merge them with the rest of the wire docs why not include reference/ and developer/ instead of moving them into a "legacy" subdir? |
Contributor
Author
it's a smaller change. incremental improvements are easier than "make everything perfect". we thought about moving it to docs.wire.com, but it's not very well organized as it is, and we neither want to spend time cleaning it up nor expose it on docs.wire.com in its current form. does that make sense? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
We've recently merged github.com/wireapp/wire-docs into github.com/wire-server/docs, which already had some stuff in it. This PR moves all the old stuff that was already there into
/docs/legacyto make it more transparent what's what.With
ln -s legacy/reference(as in d89746f), links like this one won't work any more.By linking all files individually, we would get github pages with all the information the user needs to follow the symlink, but the UX is not very nice.
So I went with keeping the files and leaving breadcrumbs inside the files.
Checklist
changelog.d.