Skip to content

Comments

Restructure documentation#2986

Merged
smatting merged 13 commits intodevelopfrom
restructure-docs-2
Jan 25, 2023
Merged

Restructure documentation#2986
smatting merged 13 commits intodevelopfrom
restructure-docs-2

Conversation

@smatting
Copy link
Contributor

@smatting smatting commented Jan 13, 2023

Tracked in https://wearezeta.atlassian.net/browse/SQPIT-1576

This PR updates hierarchical structure of the documentation. It moves several pages inside the hieararchy to hoepfully have a better overview.

Before this PR the top-level entries are

Release notes
Installation
Administration
Connecting Wire Clients
Optional Configuration
Understanding wire-server components
Single-Sign-On and user provisioning
Client API documentation
Security responses
Notes for developers

With this PR

Security responses
Installation
Administration
Reference
Developers Notes

The "Understanding wire-server components" chapter was renamed to "Reference".
Reference is meant to contain all articles, how-tos and instructions that don't fit into the "Installation" section,
for example configuration of optional feature such as as MLS, Federation, Legalhold.

The "optional configuration" section is split up: Some sections where moved into "Installation/Infrastructure configuration" others as separate articles in "Reference".

Client documentation and SSO is moved into Reference.

The release note chapter sources CHANGELOG.md from the project root

Checklist

  • Add a new entry in an appropriate subdirectory of changelog.d
  • Read and follow the PR guidelines

@smatting smatting temporarily deployed to cachix January 13, 2023 14:44 — with GitHub Actions Inactive
@smatting smatting temporarily deployed to cachix January 13, 2023 14:44 — with GitHub Actions Inactive
@zebot zebot added the ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist label Jan 13, 2023
@smatting smatting temporarily deployed to cachix January 16, 2023 14:06 — with GitHub Actions Inactive
@smatting smatting temporarily deployed to cachix January 16, 2023 14:06 — with GitHub Actions Inactive
@smatting smatting temporarily deployed to cachix January 16, 2023 14:08 — with GitHub Actions Inactive
@smatting smatting temporarily deployed to cachix January 16, 2023 14:08 — with GitHub Actions Inactive
@smatting smatting requested a review from arthurwolf January 16, 2023 14:08
@smatting smatting marked this pull request as ready for review January 16, 2023 14:08
@smatting smatting requested a review from julialongtin January 16, 2023 14:08
Copy link
Contributor

@arthurwolf arthurwolf left a comment

Choose a reason for hiding this comment

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

looks all good

@smatting smatting temporarily deployed to cachix January 25, 2023 08:40 — with GitHub Actions Inactive
@smatting smatting temporarily deployed to cachix January 25, 2023 08:40 — with GitHub Actions Inactive
@smatting smatting temporarily deployed to cachix January 25, 2023 08:50 — with GitHub Actions Inactive
@smatting smatting temporarily deployed to cachix January 25, 2023 08:50 — with GitHub Actions Inactive
@smatting smatting temporarily deployed to cachix January 25, 2023 09:20 — with GitHub Actions Inactive
@smatting smatting temporarily deployed to cachix January 25, 2023 09:21 — with GitHub Actions Inactive
@smatting smatting temporarily deployed to cachix January 25, 2023 09:21 — with GitHub Actions Inactive
@smatting smatting temporarily deployed to cachix January 25, 2023 09:21 — with GitHub Actions Inactive
@smatting smatting merged commit 2ad0819 into develop Jan 25, 2023
@smatting smatting deleted the restructure-docs-2 branch January 25, 2023 09:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants