From 4ec90b8cc3cbe69eab55661bbc57b613f568432e Mon Sep 17 00:00:00 2001 From: Matthias Fischmann Date: Tue, 30 Aug 2022 17:20:59 +0200 Subject: [PATCH 1/5] Make target audience explicit on docs.wire.com. --- changelog.d/4-docs/tweak-docs-2 | 1 + docs/src/developer/index.rst | 4 ++++ docs/src/index.rst | 9 +++++++-- 3 files changed, 12 insertions(+), 2 deletions(-) create mode 100644 changelog.d/4-docs/tweak-docs-2 diff --git a/changelog.d/4-docs/tweak-docs-2 b/changelog.d/4-docs/tweak-docs-2 new file mode 100644 index 00000000000..5164a3b9c67 --- /dev/null +++ b/changelog.d/4-docs/tweak-docs-2 @@ -0,0 +1 @@ +Make target audience explicit on docs.wire.com diff --git a/docs/src/developer/index.rst b/docs/src/developer/index.rst index 90df2360f8a..991674eabfb 100644 --- a/docs/src/developer/index.rst +++ b/docs/src/developer/index.rst @@ -1,6 +1,10 @@ Notes for developers ==================== +If you are a site operator, you may want to go back to `docs.wire.com `_ and ignore this section of the docs. + +If you are a wire end-user, please check out our `support pages `_. + What you need to know as a user of the Wire backend: concepts, features, and API. We want to keep these up to date. They could benefit from some re-ordering, and they are far from complete, but we hope they will still diff --git a/docs/src/index.rst b/docs/src/index.rst index d3f356dd33d..2303ff5d03f 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -6,10 +6,15 @@ Welcome to Wire's (self-hosting) documentation! =============================================== +If you are a wire end-user, please check out our `support pages `_. + The targeted audience of this documentation is: -* people wanting to understand how the server components of Wire work -* people wishing to self-host Wire on their own datacentres or cloud +* the curious power-user (people who want to understand how the server components of Wire work) +* site operators (people who want to self-host Wire on their own datacentres or cloud) +* developers (people who are working with the wire-server source code) + +If you are a developer, you may want to check out the "Notes for developers" first. This documentation may be expanded in the future to cover other aspects of Wire. From 88d16526e0493f46eb58d2a26ae322dc7f462e31 Mon Sep 17 00:00:00 2001 From: fisx Date: Thu, 1 Sep 2022 09:43:13 +0200 Subject: [PATCH 2/5] Update docs/src/index.rst Co-authored-by: jschaul --- docs/src/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/index.rst b/docs/src/index.rst index 2303ff5d03f..1568626a494 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -6,7 +6,7 @@ Welcome to Wire's (self-hosting) documentation! =============================================== -If you are a wire end-user, please check out our `support pages `_. +If you are a Wire end-user, please check out our `support pages `_. The targeted audience of this documentation is: From 794f45be565939c42084b8ca3fee89fb2531b921 Mon Sep 17 00:00:00 2001 From: fisx Date: Thu, 1 Sep 2022 09:43:26 +0200 Subject: [PATCH 3/5] Update docs/src/index.rst Co-authored-by: jschaul --- docs/src/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/index.rst b/docs/src/index.rst index 1568626a494..0732ae861af 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -3,7 +3,7 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Wire's (self-hosting) documentation! +Welcome to Wire's documentation! =============================================== If you are a Wire end-user, please check out our `support pages `_. From 6594c73b2937fcedf54273dfecc433c170fcae74 Mon Sep 17 00:00:00 2001 From: fisx Date: Thu, 1 Sep 2022 09:43:57 +0200 Subject: [PATCH 4/5] Update docs/src/index.rst Co-authored-by: jschaul --- docs/src/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/index.rst b/docs/src/index.rst index 0732ae861af..a45427919b4 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -11,7 +11,7 @@ If you are a Wire end-user, please check out our `support pages Date: Thu, 1 Sep 2022 09:44:11 +0200 Subject: [PATCH 5/5] Update docs/src/developer/index.rst Co-authored-by: jschaul --- docs/src/developer/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/developer/index.rst b/docs/src/developer/index.rst index 991674eabfb..b48dbecae0a 100644 --- a/docs/src/developer/index.rst +++ b/docs/src/developer/index.rst @@ -1,7 +1,7 @@ Notes for developers ==================== -If you are a site operator, you may want to go back to `docs.wire.com `_ and ignore this section of the docs. +If you are an on-premise operator (administrating your own self-hosted installation of wire-server), you may want to go back to `docs.wire.com `_ and ignore this section of the docs. If you are a wire end-user, please check out our `support pages `_.