Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 0 additions & 4 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,3 @@
path = wire-server
url = https://github.com/wireapp/wire-server.git
branch = develop
[submodule "wire-apps-jvm-sdk"]
path = wire-apps-jvm-sdk
url = https://github.com/wireapp/wire-apps-jvm-sdk.git
branch = main
2 changes: 1 addition & 1 deletion CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* @wireapp/backend @wireapp/platform-engineering @wireapp/customerops @wireapp/integrations
* @wireapp/backend @wireapp/platform-engineering @wireapp/customerops
1 change: 0 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ run: check-port build
current: prepare
@BRANCH=$$(git branch --show-current) && cd $$(cat .tmpdir) && \
git submodule update --init --depth 1 wire-server && \
git submodule update --init --depth 1 wire-apps-jvm-sdk && \
nix-shell build/default.nix --run "pipenv run mike deploy $$BRANCH && \
pipenv run mike set-default $$BRANCH && pipenv run mike serve -a 0.0.0.0:8000"

Expand Down
2 changes: 0 additions & 2 deletions build/build_versions.sh
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,6 @@ git checkout ${CURRENT_TAG}

# pull the submodule
git submodule update --init --depth 1 wire-server
git submodule update --init --depth 1 wire-apps-jvm-sdk

# Check if tag exists in mike
if [ -n "${existing_tags[$CURRENT_TAG]}" ]; then
Expand All @@ -92,7 +91,6 @@ else

# deinit the submodule to avoid issues with the next iteration
git submodule deinit -f wire-server
git submodule deinit -f wire-apps-jvm-sdk

# Set the default tag and create an alias to $CURRENT_TAG
$mike set-default $CURRENT_TAG
4 changes: 2 additions & 2 deletions build/linking-submodule/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
- The '/docs' files will be included (as linked files) in the `wire-docs` repository via a submodule and will be pulled during the build process.
- The submodule management documentation can be at [Submodule Management](../../README.md#submodule-management)

*Note: The further instructions will refer to `wire-server` as the example repository containing the documentation files, but the same applies to any other repository like `wire-apps-jvm-sdk`. Feel free to include these instructions in your own repository's documentation.*
*Note: The further instructions will refer to `wire-server` as the example repository containing the documentation files, but the same applies to any other repositories. Feel free to include these instructions in your own repository's documentation.*

## Example Diagram
![diagram](diagram.svg)
Expand All @@ -21,7 +21,7 @@
**For content in wire-server/docs:**
1. Make changes directly in the `wire-server/docs` directory
2. Create a PR against the `wire-server:develop` branch.
*Note: The `develop` branch is specific to `wire-server`. Other repositories may have different branch names, such as `main` for `wire-apps-jvm-sdk`.*
*Note: The `develop` branch is specific to `wire-server`. Other repositories may have different branch names.
3. Once merged, these changes will be picked up by `wire-docs` through submodule updates.
4. In `wire-docs`:
- Update the `wire-server` submodule (to the latest commit) and commit that change
Expand Down
2 changes: 1 addition & 1 deletion build/prepare.sh
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ else
fi

echo "Syncing all the other files changes from ${ORIGINAL_DIR}/ to ${TEMP_DIR}, to work on uncommited changes, if any"
rsync -a --exclude='/.git' --exclude="/wire-server" --exclude="/wire-apps-jvm-sdk" --exclude='wire-docs*.tar.gz' --exclude=".tmpdir" "${ORIGINAL_DIR}/" "$TEMP_DIR/"
rsync -a --exclude='/.git' --exclude="/wire-server" --exclude='wire-docs*.tar.gz' --exclude=".tmpdir" "${ORIGINAL_DIR}/" "$TEMP_DIR/"
80 changes: 38 additions & 42 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ nav:
- Upgrade process: how-to/upgrade/03-upgrade.md
- Troubleshooting: how-to/upgrade/04-troubleshooting.md
- Configuration Reference:
- Overview: how-to/upgrade/05-config-reference.md
- Wire Server 5.24: how-to/upgrade/config-references/wire-server-5.24.0.md
- Wire Server 5.25: how-to/upgrade/config-references/wire-server-5.25.0.md
- Overview: how-to/upgrade/05-config-reference.md
- Wire Server 5.24: how-to/upgrade/config-references/wire-server-5.24.0.md
- Wire Server 5.25: how-to/upgrade/config-references/wire-server-5.25.0.md
- Administration:
- Overview: how-to/administrate/README.md
- kubernetes: how-to/administrate/kubernetes/README.md
Expand Down Expand Up @@ -77,45 +77,41 @@ nav:
- Developer Notes:
- Overview: developer/README.md
- Developer:
- API versioning: developer/developer/api-versioning.md
- How to build wire-server: developer/developer/building.md
- Writing code interacting with cassandra: developer/developer/cassandra-interaction.md
- Changelog: developer/developer/changelog.md
- Coding conventions: developer/developer/coding-conventions.md
- Dependencies: developer/developer/dependencies.md
- Editor setup: developer/developer/editor-setup.md
- Features: developer/developer/features.md
- Federation API Conventions: developer/developer/federation-api-conventions.md
- Federation Design Aspects: developer/developer/federation-design-aspects.md
- Developer how-to’s: developer/developer/how-to.md
- Refactoring galley to support large conversations: developer/developer/large-conversations.md
- Linting: developer/developer/linting.md
- OpenTelemetry Instrumentation: developer/developer/open-telemetry.md
- PR Guidelines: developer/developer/pr-guidelines.md
- Internal processes: developer/developer/processes.md
- Storing SCIM-related data: developer/developer/scim/storage.md
- Servant: developer/developer/servant.md
- Testing the wire-server Haskell code base: developer/developer/testing.md
- Upgrading: developer/developer/upgrading.md
- API versioning: developer/developer/api-versioning.md
- How to build wire-server: developer/developer/building.md
- Writing code interacting with cassandra: developer/developer/cassandra-interaction.md
- Changelog: developer/developer/changelog.md
- Coding conventions: developer/developer/coding-conventions.md
- Dependencies: developer/developer/dependencies.md
- Editor setup: developer/developer/editor-setup.md
- Features: developer/developer/features.md
- Federation API Conventions: developer/developer/federation-api-conventions.md
- Federation Design Aspects: developer/developer/federation-design-aspects.md
- Developer how-to’s: developer/developer/how-to.md
- Refactoring galley to support large conversations: developer/developer/large-conversations.md
- Linting: developer/developer/linting.md
- OpenTelemetry Instrumentation: developer/developer/open-telemetry.md
- PR Guidelines: developer/developer/pr-guidelines.md
- Internal processes: developer/developer/processes.md
- Storing SCIM-related data: developer/developer/scim/storage.md
- Servant: developer/developer/servant.md
- Testing the wire-server Haskell code base: developer/developer/testing.md
- Upgrading: developer/developer/upgrading.md
- Reference:
- Config Options: developer/reference/config-options.md
- Creating and populating conversations: developer/reference/conversation.md
- Maintaining ElasticSearch: developer/reference/elastic-search.md
- ElasticSearch migration instructions for release 2021-02-16: developer/reference/elasticsearch-migration-2021-02-16.md
- Make docker and QEMU: developer/reference/make-docker-and-qemu.md
- OAuth: developer/reference/oauth.md
- SCIM tokens: developer/reference/provisioning/scim-token.md
- RabbitMQ Consumer: developer/reference/rabbitmq-consumer.md
- Spar braindump: developer/reference/spar-braindump.md
- Legal hold: developer/reference/team/legalhold.md
- User Activation: developer/reference/user/activation.md
- Connection: developer/reference/user/connection.md
- User Registration: developer/reference/user/registration.md
- User Rich info: developer/reference/user/rich-info.md
- Apps SDK:
- Understanding Apps: integrations/README.md
- Quickstart: integrations/quickstart.md
- Events: integrations/events.md
- Config Options: developer/reference/config-options.md
- Creating and populating conversations: developer/reference/conversation.md
- Maintaining ElasticSearch: developer/reference/elastic-search.md
- ElasticSearch migration instructions for release 2021-02-16: developer/reference/elasticsearch-migration-2021-02-16.md
- Make docker and QEMU: developer/reference/make-docker-and-qemu.md
- OAuth: developer/reference/oauth.md
- SCIM tokens: developer/reference/provisioning/scim-token.md
- RabbitMQ Consumer: developer/reference/rabbitmq-consumer.md
- Spar braindump: developer/reference/spar-braindump.md
- Legal hold: developer/reference/team/legalhold.md
- User Activation: developer/reference/user/activation.md
- Connection: developer/reference/user/connection.md
- User Registration: developer/reference/user/registration.md
- User Rich info: developer/reference/user/rich-info.md
- Security Responses:
- Overview: security-responses/README.md
- "2023-01-19 - Security Advisory: HTML Injection in wire.com": security-responses/2023-01-19_html_injection.md
Expand Down Expand Up @@ -207,7 +203,7 @@ markdown_extensions:
extra:
version:
provider: mike
default: latest # Default version to load
default: latest # Default version to load
social:
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/wire-secure-communication
Expand Down
3 changes: 2 additions & 1 deletion src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,15 @@ If you are a developer, you may want to check out the “Notes for developers”

Release notes of `wire-server` can be found [here](https://github.com/wireapp/wire-server/releases).

Instead, if you want to develop a Wire App using our SDKs, the documentation is [here](https://dev.wire.com).]

# Contents:

* [Installation](how-to/install/README.md)
* [Upgrade](how-to/upgrade/README.md)
* [Administration](how-to/administrate/README.md)
* [Reference](understand/README.md)
* [Developers Notes](developer/README.md)
* [Apps SDK](integrations/README.md)
* [Security responses](security-responses/README.md)
* [Release Notes](changelog/README.md)

Expand Down
1 change: 0 additions & 1 deletion src/integrations/README.md

This file was deleted.

1 change: 0 additions & 1 deletion src/integrations/events.md

This file was deleted.

1 change: 0 additions & 1 deletion src/integrations/images/quickstart_1.jpg

This file was deleted.

1 change: 0 additions & 1 deletion src/integrations/images/quickstart_2.jpg

This file was deleted.

1 change: 0 additions & 1 deletion src/integrations/images/quickstart_3.jpg

This file was deleted.

1 change: 0 additions & 1 deletion src/integrations/quickstart.md

This file was deleted.

1 change: 0 additions & 1 deletion wire-apps-jvm-sdk
Submodule wire-apps-jvm-sdk deleted from e0d456
Loading