Skip to content

Comments

Move old /docs to /docs/legacy (leaving references)#2328

Merged
fisx merged 6 commits intodevelopfrom
de-unionise-legacy-docs
Apr 28, 2022
Merged

Move old /docs to /docs/legacy (leaving references)#2328
fisx merged 6 commits intodevelopfrom
de-unionise-legacy-docs

Conversation

@fisx
Copy link
Contributor

@fisx fisx commented Apr 28, 2022

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/legacy to 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

  • The PR Title explains the impact of the change.
  • The PR description provides context as to why the change should occur and what the code contributes to that effect. This could also be a link to a JIRA ticket or a Github issue, if there is one.
  • changelog.d contains the following bits of information (details):
    • A file with the changelog entry in one or more suitable sub-sections. The sub-sections are marked by directories inside changelog.d.

@fisx fisx temporarily deployed to cachix April 28, 2022 09:01 Inactive
@fisx fisx temporarily deployed to cachix April 28, 2022 09:07 Inactive
@fisx fisx force-pushed the de-unionise-legacy-docs branch from aa3840d to 75021cb Compare April 28, 2022 09:07
@fisx fisx temporarily deployed to cachix April 28, 2022 09:07 Inactive
@fisx fisx temporarily deployed to cachix April 28, 2022 09:23 Inactive
@fisx fisx temporarily deployed to cachix April 28, 2022 09:25 Inactive
@fisx fisx changed the title Move old /docs to /docs/legacy (leaving symlinks) [skip ci] Move old /docs to /docs/legacy (leaving references) Apr 28, 2022
@fisx fisx marked this pull request as ready for review April 28, 2022 09:26
@fisx fisx requested review from battermann and smatting April 28, 2022 09:26
@smatting
Copy link
Contributor

smatting commented Apr 28, 2022

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?

@fisx
Copy link
Contributor Author

fisx commented Apr 28, 2022

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?

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?

Copy link
Contributor

@smatting smatting left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fisx yes makes sense to maybe not publish everything at once in its current form. Let's commit to creating PRs that move sections out of legacy/ to docs.wire.com.

@fisx fisx merged commit 365c29f into develop Apr 28, 2022
@fisx fisx deleted the de-unionise-legacy-docs branch April 28, 2022 10:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants