Skip to content

Update docs.wire.com #3284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fisx merged 5 commits into from
May 11, 2023
Merged

Update docs.wire.com #3284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
860f2c5
Deprecate start-services-only.sh
fisx May 11, 2023
37c9630
Fix outdated docs on how to run swagger docs locally.
fisx May 11, 2023
7a31fdf
Fixup
fisx May 11, 2023
3590ac1
Fixup
fisx May 11, 2023
716c5f4
hi ci
fisx May 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ will, eventually, have built a range of docker images. Make sure to [give Docker

See the `Makefile`s and `Dockerfile`s, as well as [build/ubuntu/README.md](build/ubuntu/README.md) for details.

#### 2. Use nix-provided build environment
#### 2. Use nix-provided build environment

This is suitable only for local development and testing. See [build instructions](./docs/src/developer/developer/building.md) in the developer documentation.

Expand All @@ -95,4 +95,4 @@ You have two options:

* Option 1. (recommended) Install wire-server on kubernetes using the configuration and instructions provided in [wire-server-deploy](https://github.com/wireapp/wire-server-deploy). This is the best option to run it on a server and recommended if you want to self-host wire-server.

* Option 2. Compile everything in this repo, then you can use the `services/start-services-only.sh`. This option is intended as a way to try out wire-server on your local development machine and not suited for production.
* Option 2. Compile everything in this repo, then you can use the `services/run-services`. This option is intended as a way to try out wire-server on your local development machine and not suited for production.
Copy link
Contributor

@lepsa lepsa May 11, 2023

Choose a reason for hiding this comment

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

Given that start-services-only.sh is only calling out to run-services, should that script be removed too?

Copy link
Contributor Author

@fisx fisx May 11, 2023

Choose a reason for hiding this comment

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

no, i'm worried somebody will still use it and stumble over the fact that it's gone. the way i changed it it doesn't do anything, but it'll point everybody who uses it in the right direction.

17 changes: 7 additions & 10 deletions docs/src/developer/developer/how-to.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,14 @@ Terminal 1:
* Set up backing services: `./deploy/dockerephemeral/run.sh`
Copy link
Contributor

@lepsa lepsa May 11, 2023

Choose a reason for hiding this comment

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

Local testings shows that it still needs the backing databases. Maybe this line should be left in, or something to the effect of having DBs accessible.

Copy link
Contributor

@elland elland May 11, 2023

Choose a reason for hiding this comment

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

Yeah that's still needed no?

Copy link
Contributor Author

@fisx fisx May 11, 2023

Choose a reason for hiding this comment

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

oops, you're right.


Terminal 2:
* Compile all services: `make c`
* Run services including nginz: `./services/start-services-only.sh`.
* Build and start wire-server services: ` make c && ./services/run-services`

Open your browser at:
[http://localhost:8080/api/swagger-ui](http://localhost:8080/api/swagger-ui) for
the Swagger 2.0 endpoints of the latest version. This endpoint is versioned;
i.e. the Swagger docs refer to the API version. Refer to the [Swagger API
documentation](../../understand/api-client-perspective/swagger.md) regarding
Swagger and API versioning.
[http://localhost:8080/api/swagger-ui](http://localhost:8080/api/swagger-ui) for a list of API verions.

Swagger json is available under [http://localhost:8080/api/swagger.json](http://localhost:8080/api/swagger.json)
Also check out the docs for swagger in our staging environment:
{ref}`swagger-api-docs`. Replace the staging domain by
`localhost:8080` to get to your local build.


## How to run federation tests across two backends
Expand Down Expand Up @@ -211,6 +208,6 @@ Note: Simply deleting the namespaces is insufficient, because it leaves some res

## How to manage RabbitMQ

We support two different ways of managing the docker-compose instance of rabbitmq:
* A web console interface is available [here](http://localhost:15672)
We support two different ways of managing the docker-compose instance of rabbitmq:
* A web console interface is available [here](http://localhost:15672)
* `rabbitmqadmin` CLI is made available in the dev environment
2 changes: 2 additions & 0 deletions docs/src/understand/api-client-perspective/swagger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
(swagger-api-docs)=

# Swagger API documentation

Our staging system provides [Swagger /
Expand Down
2 changes: 1 addition & 1 deletion services/spar/test-scim-suite/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The scripts in this directory allow to run the [SCIM Test Suite](https://github.

How to run:
```sh
./services/start-services-only.sh
./services/run-services
./services/spar/test-scim-suite/runsuite.sh
```

Expand Down
9 changes: 2 additions & 7 deletions services/start-services-only.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
#!/usr/bin/env bash

# Run all haskell services without immediately starting a test executable.
# Can be useful for manually poking at the API.
set -eo pipefail

SERVICES_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"

# call run-services, show a message, then sleep (instead of executing a test executable)
exec "$SERVICES_DIR/run-services"
echo -e "\n\n\n*** $0 is deprecated. please run '$SERVICES_DIR/run-services' instead.\n\n\n"
exit 1
2 changes: 1 addition & 1 deletion tools/stern/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ TODO: This section is under construction

## How to run stern locally

Start local services via `services/start-services-only.sh`
Start local services via `services/run-services`

Open <http://localhost:8091> in a browser.

Expand Down