Update links in CONTRIBUTING.md and README.md
This commit is contained in:
Katrin Yordanova
@@ -7,9 +7,9 @@ All contributions are welcome; from bug reports, codefixes, and new features!
|
||||
|
||||
Corteza projects are [Apache 2.0 licensed](LICENSE) and accept contributions via GitHub pull requests.
|
||||
|
||||
Cover the [terminology](https://docs.cortezaproject.org/corteza-docs/2021.9/developer-guide/release-cycle/index.html#_terminology) for the development process and versioning.
|
||||
Cover the [terminology](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/release-cycle/index.html#_terminology) for the development process and versioning.
|
||||
|
||||
Cover the [Git and GitHub](https://docs.cortezaproject.org/corteza-docs/2021.9/developer-guide/release-cycle/index.html#_github) ground rules regarding branch naming and conventions.
|
||||
Cover the [Git and GitHub](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/release-cycle/index.html#_github) ground rules regarding branch naming and conventions.
|
||||
|
||||
When you wish to start working on a code contribution, assign yourself to a GitHub issue.
|
||||
If there is no issue, create one beforehand.
|
||||
@@ -34,7 +34,7 @@ The core logic is written in GO, using [go-chi](https://pkg.go.dev/github.com/go
|
||||
Communication between the Corteza server and web applications is done using the REST API and web sockets.
|
||||
Communication between back-end services (Corteza server and Corredor) is done using gRPC.
|
||||
|
||||
The [Developer Guide/Corteza Server](https://docs.cortezaproject.org/corteza-docs/2021.9/developer-guide/corteza-server/index.html) covers the [development setup](https://docs.cortezaproject.org/corteza-docs/2021.9/developer-guide/corteza-server/index.html#_development_setup), the [project structure](https://docs.cortezaproject.org/corteza-docs/2021.9/developer-guide/corteza-server/structure.html), and the feature insight documents.
|
||||
The [Developer Guide/Corteza Server](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/corteza-server/index.html) covers the [development setup](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/corteza-server/index.html#_development_setup), the [project structure](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/corteza-server/structure.html), and the feature insight documents.
|
||||
|
||||
|
||||
### Corteza Web Applications
|
||||
@@ -49,14 +49,14 @@ The repositories:
|
||||
|
||||
Communication between the Corteza server and web applications is done using the REST API and web sockets.
|
||||
|
||||
The [Developer Guide/Corteza Web Applications](https://docs.cortezaproject.org/corteza-docs/2021.9/developer-guide/web-applications/index.html) covers the [development setup](https://docs.cortezaproject.org/corteza-docs/2021.9/developer-guide/web-applications/index.html#_development_setup), the [project structure](https://docs.cortezaproject.org/corteza-docs/2021.9/developer-guide/web-applications/structure.html), and the feature insight documents.
|
||||
The [Developer Guide/Corteza Web Applications](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/web-applications/index.html) covers the [development setup](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/web-applications/index.html#_development_setup), the [project structure](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/web-applications/structure.html), and the feature insight documents.
|
||||
|
||||
### Documentation
|
||||
|
||||
The documentation is written in [AsciiDoc](https://asciidoc.org/) and compiled using [Antora](https://antora.org/).
|
||||
The source code is available on the [GitHub cortezaproject/corteza-docs repository](https://github.com/cortezaproject/corteza-docs); the generated output is available on the [documentation page](http://docs.cortezaproject.org/).
|
||||
|
||||
The [Developer Guide/Documentation](https://docs.cortezaproject.org/corteza-docs/2021.9/developer-guide/documentation/index.html) covers the [conventions](https://docs.cortezaproject.org/corteza-docs/2021.9/developer-guide/documentation/index.html#_conventions), [writing guidelines](https://docs.cortezaproject.org/corteza-docs/2021.9/developer-guide/documentation/index.html#documentation-writing-guidelines), as well as some [examples](https://docs.cortezaproject.org/corteza-docs/2021.9/developer-guide/documentation/examples/index.html) to help you get started.
|
||||
The [Developer Guide/Documentation](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/documentation/index.html) covers the [conventions](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/documentation/index.html#_conventions), [writing guidelines](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/documentation/index.html#documentation-writing-guidelines), as well as some [examples](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/documentation/examples/index.html) to help you get started.
|
||||
|
||||
## Bug reporting
|
||||
|
||||
|
||||
28
README.md
28
README.md
@@ -53,44 +53,44 @@ You can check out Corteza online by creating an account on our community instanc
|
||||
|
||||
## Deploying Corteza
|
||||
|
||||
Refer to the [DevOps guide](https://docs.cortezaproject.org/corteza-docs/2021.9/devops-guide/index.html) for a complete guide on how to get Corteza up and running.
|
||||
Refer to the [DevOps guide](https://docs.cortezaproject.org/corteza-docs/2022.3/devops-guide/index.html) for a complete guide on how to get Corteza up and running.
|
||||
Additionally, we've provided some [video instructions](https://forum.cortezaproject.org/t/videos-on-how-to-set-up-corteza/91).
|
||||
|
||||
Quick references:
|
||||
|
||||
* [data backup and restore](https://docs.cortezaproject.org/corteza-docs/2021.9/devops-guide/maintenance/backups.html)
|
||||
* [troubleshooting](https://docs.cortezaproject.org/corteza-docs/2021.9/devops-guide/maintenance/troubleshooting.html)
|
||||
* [setting up an email relay](https://docs.cortezaproject.org/corteza-docs/2021.9/devops-guide/extension-requirements/email-relay.html)
|
||||
* [setting up sink routes](https://docs.cortezaproject.org/corteza-docs/2021.9/devops-guide/extension-requirements/sink-route.html)
|
||||
* [data backup and restore](https://docs.cortezaproject.org/corteza-docs/2022.3/devops-guide/maintenance/backups.html)
|
||||
* [troubleshooting](https://docs.cortezaproject.org/corteza-docs/2022.3/devops-guide/maintenance/troubleshooting.html)
|
||||
* [setting up an email relay](https://docs.cortezaproject.org/corteza-docs/2022.3/devops-guide/extension-requirements/email-relay.html)
|
||||
* [setting up sink routes](https://docs.cortezaproject.org/corteza-docs/2022.3/devops-guide/extension-requirements/sink-route.html)
|
||||
|
||||
## Upgrading Corteza
|
||||
|
||||
[](https://img.shields.io/github/v/tag/cortezaproject/corteza-js?label=latest%20stable%20version)
|
||||
|
||||
Refer to the [changelog](https://docs.cortezaproject.org/corteza-docs/2021.9/changelog/index.html) and the [upgrade guide](https://docs.cortezaproject.org/corteza-docs/2021.9/upgrade-guide/index.html) to upgrade your Corteza instance.
|
||||
Refer to the [changelog](https://docs.cortezaproject.org/corteza-docs/2022.3/changelog/index.html) and the [upgrade guide](https://docs.cortezaproject.org/corteza-docs/2022.3/upgrade-guide/index.html) to upgrade your Corteza instance.
|
||||
|
||||
## Using Corteza
|
||||
|
||||
Refer to the [End-User Guide](https://docs.cortezaproject.org/corteza-docs/2021.9/end-user-guide/index.html) to learn the built-in applications and features from the end-user perspective.
|
||||
Refer to the [End-User Guide](https://docs.cortezaproject.org/corteza-docs/2022.3/end-user-guide/index.html) to learn the built-in applications and features from the end-user perspective.
|
||||
|
||||
Quick references:
|
||||
|
||||
* [Corteza CRM](https://docs.cortezaproject.org/corteza-docs/2021.9/end-user-guide/crm/index.html)
|
||||
* [Corteza Case Management](https://docs.cortezaproject.org/corteza-docs/2021.9/end-user-guide/case-management/index.html)
|
||||
* [Corteza CRM](https://docs.cortezaproject.org/corteza-docs/2022.3/end-user-guide/crm/index.html)
|
||||
* [Corteza Case Management](https://docs.cortezaproject.org/corteza-docs/2022.3/end-user-guide/case-management/index.html)
|
||||
|
||||
## Create with Corteza
|
||||
|
||||
Refer to the [Integrator Guide](https://docs.cortezaproject.org/corteza-docs/2021.9/integrator-guide/index.html) to learn how you can build on the core features to create virtually anything.
|
||||
Refer to the [Integrator Guide](https://docs.cortezaproject.org/corteza-docs/2022.3/integrator-guide/index.html) to learn how you can build on the core features to create virtually anything.
|
||||
|
||||
Quick references:
|
||||
|
||||
* [Corteza Compose configuration](https://docs.cortezaproject.org/corteza-docs/2021.9/integrator-guide/compose-configuration/index.html)
|
||||
* automation using [workflows](https://docs.cortezaproject.org/corteza-docs/2021.9/integrator-guide/automation/workflows/index.html) and [automation scripts](https://docs.cortezaproject.org/corteza-docs/2021.9/integrator-guide/automation/automation-scripts/index.html)
|
||||
* [using the REST API](https://docs.cortezaproject.org/corteza-docs/2021.9/integrator-guide/accessing-corteza/index.html),
|
||||
* [Corteza Compose configuration](https://docs.cortezaproject.org/corteza-docs/2022.3/integrator-guide/compose-configuration/index.html)
|
||||
* automation using [workflows](https://docs.cortezaproject.org/corteza-docs/2022.3/integrator-guide/automation/workflows/index.html) and [automation scripts](https://docs.cortezaproject.org/corteza-docs/2022.3/integrator-guide/automation/automation-scripts/index.html)
|
||||
* [using the REST API](https://docs.cortezaproject.org/corteza-docs/2022.3/integrator-guide/accessing-corteza/index.html),
|
||||
|
||||
## Contributing
|
||||
|
||||
Refer to the [Developer Guide/Corteza JS](https://docs.cortezaproject.org/corteza-docs/2021.9/developer-guide/corteza-js/index.html) document for details regarding the [development setup](https://docs.cortezaproject.org/corteza-docs/2021.9/developer-guide/corteza-js/index.html#_development_setup), the [project structure](https://docs.cortezaproject.org/corteza-docs/2021.9/developer-guide/corteza-js/structure.html), and the feature insight documents.
|
||||
Refer to the [Developer Guide/Corteza JS](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/corteza-js/index.html) document for details regarding the [development setup](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/corteza-js/index.html#_development_setup), the [project structure](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/corteza-js/structure.html), and the feature insight documents.
|
||||
|
||||
Refer to the [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines and code of conduct.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user