Skip to content

Comments

Docs/fs 698 docs improvements#2524

Merged
arthurwolf merged 12 commits intodevelopfrom
docs/fs-698-docs-improvements
Jul 4, 2022
Merged

Docs/fs 698 docs improvements#2524
arthurwolf merged 12 commits intodevelopfrom
docs/fs-698-docs-improvements

Conversation

@arthurwolf
Copy link
Contributor

@arthurwolf arthurwolf commented Jun 29, 2022

Screenshot 2022-06-29 at 22-55-54 Part 3 - configuration options in a production setup — Wire 0 0 4 documentation

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.
  • If this PR changes development workflow or dependencies, they have been A) automated and B) documented under docs/developer/. All efforts have been taken to minimize development setup breakage or slowdown for co-workers.
  • If HTTP endpoint paths have been added or renamed, or feature configs have changed, the endpoint / config-flag checklist (see Wire-employee only backend wiki page) has been followed.
  • If a cassandra schema migration has been added, I ran make git-add-cassandra-schema to update the cassandra schema documentation.
  • 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.
    • If new config options introduced: added usage description under docs/reference/config-options.md
    • If new config options introduced: recommended measures to be taken by on-premise instance operators.
    • If a cassandra schema migration is backwards incompatible (see also these docs), measures to be taken by on-premise instance operators are explained.
    • If a data migration (not schema migration) introduced: measures to be taken by on-premise instance operators.
    • If public end-points have been changed or added: does nginz need un upgrade?
    • If internal end-points have been added or changed: which services have to be deployed in a specific order?

@arthurwolf arthurwolf temporarily deployed to cachix June 29, 2022 20:57 Inactive
@smatting smatting self-requested a review June 30, 2022 08:42
@arthurwolf arthurwolf temporarily deployed to cachix June 30, 2022 12:28 Inactive
@arthurwolf arthurwolf temporarily deployed to cachix July 4, 2022 09:29 Inactive
@smatting smatting self-requested a review July 4, 2022 09:43
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.

LGTM 👍

@arthurwolf arthurwolf merged commit b39fc01 into develop Jul 4, 2022
@arthurwolf arthurwolf deleted the docs/fs-698-docs-improvements branch July 4, 2022 09:44
@arthurwolf
Copy link
Contributor Author

Merged! Thanks @smatting for the review!
@paulwire fyi

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