Skip to content

Commit

Permalink
NOISSUE - Fix links in README.md file (#2129)
Browse files Browse the repository at this point in the history
Signed-off-by: Dusan Borovcanin <[email protected]>
  • Loading branch information
dborovcanin authored Apr 3, 2024
1 parent 6594136 commit a39d462
Show file tree
Hide file tree
Showing 71 changed files with 267 additions and 263 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ blank_issues_enabled: false
contact_links:
- name: Google group
url: https://groups.google.com/forum/#!forum/mainflux
about: Join the Mainflux community on Google group.
about: Join the Magistrala community on Google group.
- name: Gitter
url: https://gitter.im/mainflux/mainflux
about: Join the Mainflux community on Gitter.
about: Join the Magistrala community on Gitter.
2 changes: 1 addition & 1 deletion .github/workflows/swagger-ui.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ jobs:
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: swagger-ui
cname: api.mainflux.io
cname: docs.api.magistrala.abstractmachines.fr
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Check that `.env` file contains:
MG_RELEASE_TAG=<release_number>
```

> `docker-compose` should be used for development and testing deployments. For production we suggest using [Kubernetes](https://docs.mainflux.io/kubernetes).
> `docker-compose` should be used for development and testing deployments. For production we suggest using [Kubernetes](https://docs.magistrala.abstractmachines.fr/kubernetes).
## Usage

Expand All @@ -87,11 +87,11 @@ make cli
./build/cli version
```

Additional details on using the CLI can be found in the [CLI documentation](https://docs.mainflux.io/cli).
Additional details on using the CLI can be found in the [CLI documentation](https://docs.magistrala.abstractmachines.fr/cli).

## Documentation

Official documentation is hosted at [Magistrala official docs page][docs]. Documentation is auto-generated, checkout the instructions on [official docs repository](https://github.com/mainflux/docs):
Official documentation is hosted at [Magistrala official docs page][docs]. Documentation is auto-generated, checkout the instructions on [official docs repository](https://github.com/absmach/magistrala-docs):

If you spot an error or a need for corrections, please let us know - or even better: send us a PR.

Expand Down Expand Up @@ -137,8 +137,7 @@ You like Magistrala and you would like to make it your day job? We're always loo

[Apache-2.0](LICENSE)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmainflux%2Fmainflux.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmainflux%2Fmainflux?ref=badge_large)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fabsmach%2Fmagistrala.svg?type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fabsmach%2Fmagistrala?ref=badge_large&issueType=license)
## Data Collection for Magistrala

Magistrala is committed to continuously improving its services and ensuring a seamless experience for its users. To achieve this, we collect certain data from your deployments. Rest assured, this data is collected solely for the purpose of enhancing Magistrala and is not used with any malicious intent. The deployment summary can be found on our [website][callhome].
Expand All @@ -157,8 +156,8 @@ Data collection is on by default and can be disabled by setting the env variable

By utilizing Magistrala, you actively contribute to its improvement. Together, we can build a more robust and efficient IoT platform. Thank you for your trust in Magistrala!

[banner]: https://github.com/mainflux/docs/blob/master/docs/img/gopherBanner.jpg
[docs]: https://docs.mainflux.io
[banner]: https://github.com/absmach/magistrala-docs/blob/main/docs/img/gopherBanner.jpg
[docs]: https://docs.magistrala.abstractmachines.fr
[docker]: https://www.docker.com
[forum]: https://groups.google.com/forum/#!forum/mainflux
[gitter]: https://gitter.im/absmach/magistrala?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
Expand All @@ -168,11 +167,11 @@ By utilizing Magistrala, you actively contribute to its improvement. Together, w
[cov-badge]: https://codecov.io/gh/absmach/magistrala/graph/badge.svg?token=SEMDAO3L09
[cov-url]: https://codecov.io/gh/absmach/magistrala
[license]: https://img.shields.io/badge/license-Apache%20v2.0-blue.svg
[twitter]: https://twitter.com/mainflux
[twitter]: https://twitter.com/absmach
[lora]: https://lora-alliance.org/
[opcua]: https://opcfoundation.org/about/opc-technologies/opc-ua/
[agent]: https://github.com/mainflux/agent
[export]: https://github.com/mainflux/export
[agent]: https://github.com/absmach/agent
[export]: https://github.com/absmach/export
[kubernetes]: https://kubernetes.io/
[releases]: https://github.com/absmach/magistrala/releases
[drasko]: https://github.com/drasko
Expand All @@ -190,4 +189,4 @@ By utilizing Magistrala, you actively contribute to its improvement. Together, w
[dusanm]: https://github.com/malidukica
[mirko]: https://github.com/mteodor
[rodneyosodo]: https://github.com/rodneyosodo
[callhome]: https://deployments.mainflux.io
[callhome]: https://deployments.magistrala.abstractmachines.fr/
2 changes: 1 addition & 1 deletion api/asyncapi/mqtt.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ info:
contact:
name: Magistrala Team
url: 'https://github.com/absmach/magistrala'
email: info@mainflux.com
email: info@abstractmachines.fr
description: |
MQTT adapter provides an MQTT API for sending messages through the platform. MQTT adapter uses [mProxy](https://github.com/absmach/mproxy) for proxying traffic between client and MQTT broker.
Additionally, the MQTT adapter and the message broker are replicating the traffic between brokers.
Expand Down
2 changes: 1 addition & 1 deletion api/asyncapi/websocket.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ info:
contact:
name: Magistrala Team
url: 'https://github.com/absmach/magistrala'
email: info@mainflux.com
email: info@abstractmachines.fr
license:
name: Apache 2.0
url: 'https://github.com/absmach/magistrala/blob/master/LICENSE'
Expand Down
2 changes: 1 addition & 1 deletion api/openapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

This folder contains an OpenAPI specifications for Magistrala API.

View specification in Swagger UI at [api.mainflux.io](https://api.mainflux.io)
View specification in Swagger UI at [docs.api.magistrala.abstractmachines.fr](https://docs.api.magistrala.abstractmachines.fr)
2 changes: 1 addition & 1 deletion api/openapi/auth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ info:
Some useful links:
- [The Magistrala repository](https://github.com/absmach/magistrala)
contact:
email: info@mainflux.com
email: info@abstractmachines.fr
license:
name: Apache 2.0
url: https://github.com/absmach/magistrala/blob/master/LICENSE
Expand Down
2 changes: 1 addition & 1 deletion api/openapi/bootstrap.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ info:
Some useful links:
- [The Magistrala repository](https://github.com/absmach/magistrala)
contact:
email: info@mainflux.com
email: info@abstractmachines.fr
license:
name: Apache 2.0
url: https://github.com/absmach/magistrala/blob/master/LICENSE
Expand Down
2 changes: 1 addition & 1 deletion api/openapi/certs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ info:
Some useful links:
- [The Magistrala repository](https://github.com/absmach/magistrala)
contact:
email: info@mainflux.com
email: info@abstractmachines.fr
license:
name: Apache 2.0
url: https://github.com/absmach/magistrala/blob/master/LICENSE
Expand Down
2 changes: 1 addition & 1 deletion api/openapi/consumers-notifiers.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ info:
Some useful links:
- [The Magistrala repository](https://github.com/absmach/magistrala)
contact:
email: info@mainflux.com
email: info@abstractmachines.fr
license:
name: Apache 2.0
url: https://github.com/absmach/magistrala/blob/master/LICENSE
Expand Down
2 changes: 1 addition & 1 deletion api/openapi/http.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ info:
Some useful links:
- [The Magistrala repository](https://github.com/absmach/magistrala)
contact:
email: info@mainflux.com
email: info@abstractmachines.fr
license:
name: Apache 2.0
url: https://github.com/absmach/magistrala/blob/master/LICENSE
Expand Down
2 changes: 1 addition & 1 deletion api/openapi/invitations.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ info:
Some useful links:
- [The Magistrala repository](https://github.com/absmach/magistrala)
contact:
email: info@mainflux.com
email: info@abstractmachines.fr
license:
name: Apache 2.0
url: https://github.com/absmach/magistrala/blob/master/LICENSE
Expand Down
2 changes: 1 addition & 1 deletion api/openapi/provision.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ info:
Some useful links:
- [The Magistrala repository](https://github.com/absmach/magistrala)
contact:
email: info@mainflux.com
email: info@abstracmachines.fr
license:
name: Apache 2.0
url: https://github.com/absmach/magistrala/blob/master/LICENSE
Expand Down
2 changes: 1 addition & 1 deletion api/openapi/readers.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ info:
Some useful links:
- [The Magistrala repository](https://github.com/absmach/magistrala)
contact:
email: info@mainflux.com
email: info@abstractmachines.fr
license:
name: Apache 2.0
url: https://github.com/absmach/magistrala/blob/master/LICENSE
Expand Down
2 changes: 1 addition & 1 deletion api/openapi/things.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ info:
Some useful links:
- [The Magistrala repository](https://github.com/absmach/magistrala)
contact:
email: info@mainflux.com
email: info@abstractmachines.fr
license:
name: Apache 2.0
url: https://github.com/absmach/magistrala/blob/master/LICENSE
Expand Down
2 changes: 1 addition & 1 deletion api/openapi/twins.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ info:
Some useful links:
- [The Magistrala repository](https://github.com/absmach/magistrala)
contact:
email: info@mainflux.com
email: info@abstractmachines.fr
license:
name: Apache 2.0
url: https://github.com/absmach/magistrala/blob/master/LICENSE
Expand Down
2 changes: 1 addition & 1 deletion api/openapi/users.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ info:
Some useful links:
- [The Magistrala repository](https://github.com/absmach/magistrala)
contact:
email: info@mainflux.com
email: info@abstractmachines.fr
license:
name: Apache 2.0
url: https://github.com/absmach/magistrala/blob/master/LICENSE
Expand Down
4 changes: 2 additions & 2 deletions auth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,6 @@ Setting `MG_AUTH_GRPC_SERVER_CERT` and `MG_AUTH_GRPC_SERVER_KEY` will enable TLS

## Usage

For more information about service capabilities and its usage, please check out the [API documentation](https://api.mainflux.io/?urls.primaryName=auth.yml).
For more information about service capabilities and its usage, please check out the [API documentation](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=auth.yml).

[doc]: https://docs.mainflux.io
[doc]: https://docs.magistrala.abstractmachines.fr
2 changes: 1 addition & 1 deletion auth/tracing/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
// Magistrala Users service.
//
// For more details about tracing instrumentation for Magistrala messaging refer
// to the documentation at https://docs.mainflux.io/tracing/.
// to the documentation at https://docs.magistrala.abstractmachines.fr/tracing/.
package tracing
2 changes: 1 addition & 1 deletion bootstrap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,4 +119,4 @@ Setting `MG_AUTH_GRPC_CLIENT_CERT` and `MG_AUTH_GRPC_CLIENT_KEY` will enable TLS

## Usage

For more information about service capabilities and its usage, please check out the [API documentation](https://api.mainflux.io/?urls.primaryName=bootstrap.yml).
For more information about service capabilities and its usage, please check out the [API documentation](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=bootstrap.yml).
2 changes: 1 addition & 1 deletion bootstrap/tracing/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
// Magistrala Users service.
//
// For more details about tracing instrumentation for Magistrala messaging refer
// to the documentation at https://docs.mainflux.io/tracing/.
// to the documentation at https://docs.magistrala.abstractmachines.fr/tracing/.
package tracing
2 changes: 1 addition & 1 deletion certs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,4 +127,4 @@ Setting `MG_AUTH_GRPC_CLIENT_CERT` and `MG_AUTH_GRPC_CLIENT_KEY` will enable TLS

## Usage

For more information about service capabilities and its usage, please check out the [Certs section](https://docs.mainflux.io/certs/).
For more information about service capabilities and its usage, please check out the [Certs section](https://docs.magistrala.abstractmachines.fr/certs/).
2 changes: 1 addition & 1 deletion certs/tracing/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
// Magistrala Users Groups service.
//
// For more details about tracing instrumentation for Magistrala messaging refer
// to the documentation at https://docs.mainflux.io/tracing/.
// to the documentation at https://docs.magistrala.abstractmachines.fr/tracing/.
package tracing
2 changes: 1 addition & 1 deletion coap/tracing/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
// Magistrala WebSocket adapter service.
//
// For more details about tracing instrumentation for Magistrala messaging refer
// to the documentation at https://docs.mainflux.io/tracing/.
// to the documentation at https://docs.magistrala.abstractmachines.fr/tracing/.
package tracing
4 changes: 2 additions & 2 deletions consumers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ For an in-depth explanation of the usage of `consumers`, as well as thorough
understanding of Magistrala, please check out the [official documentation][doc].

For more information about service capabilities and its usage, please check out
the [API documentation](https://api.mainflux.io/?urls.primaryName=consumers-notifiers-openapi.yml).
the [API documentation](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=consumers-notifiers-openapi.yml).

[doc]: https://docs.mainflux.io
[doc]: https://docs.magistrala.abstractmachines.fr
2 changes: 1 addition & 1 deletion consumers/notifiers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ default values.

Subscriptions service will start consuming messages and sending notifications when a message is received.

[doc]: https://docs.mainflux.io
[doc]: https://docs.magistrala.abstractmachines.fr
3 changes: 2 additions & 1 deletion consumers/notifiers/smpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,5 @@ default values.

Starting service will start consuming messages and sending SMS when a message is received.

[doc]: http://mainflux.readthedocs.io
[doc]: https://docs.magistrala.abstractmachines.fr

2 changes: 1 addition & 1 deletion consumers/notifiers/smtp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ default values.

Starting service will start consuming messages and sending emails when a message is received.

[doc]: https://docs.mainflux.io
[doc]: https://docs.magistrala.abstractmachines.fr
2 changes: 1 addition & 1 deletion consumers/notifiers/tracing/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
// Magistrala WebSocket adapter service.
//
// For more details about tracing instrumentation for Magistrala messaging refer
// to the documentation at https://docs.mainflux.io/tracing/.
// to the documentation at https://docs.magistrala.abstractmachines.fr/tracing/.
package tracing
2 changes: 1 addition & 1 deletion consumers/writers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ the [Docker Compose][compose] file.
For an in-depth explanation of the usage of `writers`, as well as thorough
understanding of Magistrala, please check out the [official documentation][doc].

[doc]: https://docs.mainflux.io
[doc]: https://docs.magistrala.abstractmachines.fr
[compose]: ../docker/docker-compose.yml
2 changes: 1 addition & 1 deletion consumers/writers/cassandra/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,4 @@ execute following command:

Starting service will start consuming normalized messages in SenML format.

[doc]: https://docs.mainflux.io
[doc]: https://docs.magistrala.abstractmachines.fr
2 changes: 1 addition & 1 deletion consumers/writers/influxdb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,4 @@ _Please note that you need to start core services before the additional ones._

Starting service will start consuming normalized messages in SenML format.

Official docs can be found [here](https://docs.mainflux.io).
Official docs can be found [here](https://docs.magistrala.abstractmachines.fr).
Loading

0 comments on commit a39d462

Please sign in to comment.