Skip to content

Commit

Permalink
IGAPP-333: Move and adjust commonly used docs
Browse files Browse the repository at this point in the history
  • Loading branch information
steffenkleinle committed Oct 23, 2020
1 parent 47d55ba commit 053ad09
Show file tree
Hide file tree
Showing 9 changed files with 14 additions and 97 deletions.
24 changes: 0 additions & 24 deletions .github/CONTRIBUTING.md

This file was deleted.

File renamed without changes.
6 changes: 5 additions & 1 deletion docs/build-configs.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ We use the concept of build configs to build different versions of the app. A bu
* **integreat**: Build config for Integreat using the production integreat cms.
* **malte**: Build config for the Malte app which uses a different design, name and cms.
* **integreat-test-cms**: Build config for development using the test cms and with additional features enabled.
* **integreat-e2e**: Build config for [E2E-Tests](native/docs/e2e-testing.md), primarily used in the [CI](docs/cicd.md).
* **integreat-e2e**: Build config for [E2E-Tests](native/docs/e2e-testing.md), primarily used in the [CI](cicd.md).

**NOTE: Testing and developing with the live cms instance should be avoided. Therefore, the `integreat-test-cms` build config should be used primarily.**

Expand All @@ -24,3 +24,7 @@ See the corresponding sections for [native](native/docs/build-configs.md#using-a

Each build config is a set of javascript files (possibly including common files) that can be found in the [corresponding directory](../build-configs/configs).
See the corresponding sections for [native](native/docs/build-configs.md#technical-information) and [web](web/docs/build-configs.md#technical-information).

## Whitelabelling

If you want to add more build configs in order to create a new whitelabelled app, have a look at the [whitellabelling docu](whitelabelling.md).
4 changes: 4 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ Other team members you can contact are

## Pull requests

**Testing with the live cms instance should be avoided. Instead, [please use the test cms](docs/technology-stack.md#test-cms).**

Before starting to write code and opening a pull request, please take a look [at our conventions](docs/conventions.md).

Pull requests should always belong to an [issue in our issue tracker](#bug-reporting).
Expand All @@ -45,5 +47,7 @@ They are also shown in the stores and the [release section of github](https://gi

## Bug reporting

**Testing with the live cms instance should be avoided. Instead, [please use the test cms](docs/technology-stack.md#test-cms).**

You can [view our issues](https://issues.integreat-app.de/projects/NATIVE) or
[create new ones](https://issues.integreat-app.de/secure/CreateIssue!default.jspa) on our jira.
5 changes: 4 additions & 1 deletion native/docs/whitelabelling.md → docs/whitelabelling.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,10 @@ Things the AppTeam has to do and therefore probably create issues for.
* Android
* iOS
* Add sentry flag
* Create screenshots
* Create screenshots with the following aspect ratios (for iOS):
* 1242 x 2208
* 1242 x 2688
* 2048 x 2732
* Add to google search console
* Translate and add locales
* New languages
Expand Down
File renamed without changes.
69 changes: 0 additions & 69 deletions native/CHANGELOG.md

This file was deleted.

1 change: 0 additions & 1 deletion native/docs/technical-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
* [I18n](docs/i18n.md)
* [Error reporting](docs/error-reporting.md)
* [React Native Upgrades](docs/react-native-upgrades.md)
* [Whitelabelling](docs/whitelabelling.md)

## Technology Stack

Expand Down
2 changes: 1 addition & 1 deletion native/docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,4 @@ More information on how to set the environment variable can be found [here](buil
## Invalid BUILD_CONFIG_NAME supplied

Invalid environment variable `BUILD_CONFIG_NAME` set before running the packager.
All available build configs can be found [here](build-configs.md#available-build-configs).
All available build configs can be found [here](../../docs/build-configs.md#available-build-configs).

0 comments on commit 053ad09

Please sign in to comment.