NOISSUE - Fix Pages deployment (#169)

* Update pages action Signed-off-by: Dusan Borovcanin <[email protected]> * Remove GitHub action Signed-off-by: Dusan Borovcanin <[email protected]> * Remove CNAME Signed-off-by: Dusan Borovcanin <[email protected]> * Create CNAME * Fix docs Signed-off-by: Dusan Borovcanin <[email protected]> * Revert Actions Signed-off-by: Dusan Borovcanin <[email protected]> * remove custom domain Signed-off-by: Arvindh <[email protected]> * update actions version to 4 Signed-off-by: Arvindh <[email protected]> * update permissions Signed-off-by: Arvindh <[email protected]> * update domain name Signed-off-by: Arvindh <[email protected]> * remove CNAME file Signed-off-by: Arvindh <[email protected]> * Update branches list Signed-off-by: Dusan Borovcanin <[email protected]> --------- Signed-off-by: Dusan Borovcanin <[email protected]> Signed-off-by: Arvindh <[email protected]> Co-authored-by: Arvindh <[email protected]>
absmach · Jan 31, 2024 · 94b5cbf · 94b5cbf
1 parent a9e82a1
commit 94b5cbf
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 26 deletions.
diff --git a/.github/workflows/main.yaml → .github/workflows/pages.yml b/.github/workflows/main.yaml → .github/workflows/pages.yml
@@ -1,26 +1,28 @@
 name: Publish docs via GitHub Pages
 
-# Controls when the action will run. 
+# Controls when the action will run
 on:
   push:
     branches:
-      - master
+      - main
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
-
+permissions:
+  contents: write
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
   build:
     name: Deploy docs
     runs-on: ubuntu-latest
     steps:
       - name: Checkout master
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Deploy docs
         uses: mhausenblas/mkdocs-deploy-gh-pages@master
         # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          CUSTOM_DOMAIN: docs.mainflux.io
+          CUSTOM_DOMAIN: docs.magistrala.abstractmachines.fr
+
diff --git a/README.md b/README.md
@@ -1,8 +1,9 @@
 # Magistrala
 
-![build][build]
 [![license][license]](LICENSE)
-[![chat][gitter-badge]][gitter]
+[build][build]
+[![Build](https://github.com/absmach/magistrala-docs/actions/workflows/pages.yaml/badge.svg?branch=main)](https://github.com/absmach/magistrala-docs/actions/workflows/pages.yaml)
+
 
 This repo collects the collaborative work on Magistrala documentation.
 The official documentation is hosted at [Magistrala Docs page][docs].
@@ -25,7 +26,7 @@ pip install mkdocs
 Doc repo can be fetched from GitHub:
 
 ```bash
-git clone [email protected]:mainflux/docs.git
+git clone [email protected]:/absmach/magistrala-docs.git
 ```
 
 ## Usage
@@ -42,23 +43,21 @@ Then just point the browser to `http://127.0.0.1:8000`.
 
 Thank you for your interest in Magistrala and the desire to contribute!
 
-1. Take a look at our [open issues](https://github.com/mainflux/docs/issues). The [good-first-issue](https://github.com/mainflux/docs/labels/good-first-issue) label is specifically for issues that are great for getting started.
+1. Take a look at our [open issues](https://github.com/absmach/magistrala-docs/issues). The [good-first-issue](https://github.com/absmach/magistrala-docs/labels/good-first-issue) label is specifically for issues that are great for getting started.
 2. Check out the [contribution guide](CONTRIBUTING.md) to learn more about our style and conventions.
 3. Make your changes compatible with our workflow.
 
 ## Community
 
-- [Gitter][gitter]
+- [Matrix][matrix]
 - [Twitter][twitter]
 
 ## License
 
 [Apache-2.0](LICENSE)
 
-[gitter]: https://gitter.im/mainflux/mainflux?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
-[gitter-badge]: https://badges.gitter.im/Join%20Chat.svg
+[matrix]: https://matrix.to/#/#Mainflux_mainflux:gitter.im
 [license]: https://img.shields.io/badge/license-Apache%20v2.0-blue.svg
-[blog]: https://medium.com/mainflux-iot-platform
-[twitter]: https://twitter.com/mainflux
-[docs]: https://docs.mainflux.io
-[build]: https://github.com/mainflux/docs/actions/workflows/main.yaml/badge.svg
+[blog]: https://medium.com/abstract-machines-blog
+[twitter]: https://twitter.com/absmach
+[docs]: https://docs.magistrala.abstractmachines.fr
diff --git a/docs/CNAME b/docs/CNAME
diff --git a/docs/api.md b/docs/api.md
@@ -2,13 +2,13 @@
 
 ## Reference
 
-API reference in the Swagger UI can be found at: [https://api.mainflux.io][api]
+API reference in the Swagger UI can be found at: [https://api.magistrala.abstractmachines.fr][api]
 
 ## Users
 
 ### Create User
 
-To start working with the Magistrala system, you need to create a user account.
+To start working with the Mainflux system, you need to create a user account.
 
 > Identity, which can be email-address (this must be unique as it identifies the user) and secret (password must contain at least 8 characters).
 
@@ -97,7 +97,7 @@ Access-Control-Expose-Headers: Location
 
 ### Create Token
 
-To log in to the Magistrala system, you need to create a `user_token`.
+To log in to the Mainflux system, you need to create a `user_token`.
 
 ```bash
 curl -sSiX POST http://localhost/users/tokens/issue -H "Content-Type: application/json" -d @- << EOF
@@ -682,9 +682,9 @@ Access-Control-Expose-Headers: Location
 
 ### Create Thing with External ID
 
-It is often the case that the user will want to integrate the existing solutions, e.g. an asset management system, with the Magistrala platform. To simplify the integration between the systems and avoid artificial cross-platform reference, such as special fields in Magistrala Things metadata, it is possible to set Magistrala Thing ID with an existing unique ID while create the Thing. This way, the user can set the existing ID as the Thing ID of a newly created Thing to keep reference between Thing and the asset that Thing represents.
+It is often the case that the user will want to integrate the existing solutions, e.g. an asset management system, with the Mainflux platform. To simplify the integration between the systems and avoid artificial cross-platform reference, such as special fields in Mainflux Things metadata, it is possible to set Mainflux Thing ID with an existing unique ID while create the Thing. This way, the user can set the existing ID as the Thing ID of a newly created Thing to keep reference between Thing and the asset that Thing represents.
 
-The limitation is that the existing ID has to be unique in the Magistrala domain.
+The limitation is that the existing ID has to be unique in the Mainflux domain.
 
 To create a thing with an external ID, you need to provide the ID together with thing name, and other fields as well as a `user_token`
 
@@ -720,8 +720,8 @@ Access-Control-Expose-Headers: Location
 
 ### Create Thing with External Secret
 
-It is often the case that the user will want to integrate the existing solutions, e.g. an asset management system, with the Magistrala platform. To simplify the integration between the systems and avoid artificial cross-platform reference, such as special fields in Magistrala Things metadata, it is possible to set Magistrala Thing secret with an existing unique secret when creating the Thing. This way, the user can set the existing secret as the Thing secret of a newly created Thing to keep reference between Thing and the asset that Thing represents.
-The limitation is that the existing secret has to be unique in the Magistrala domain.
+It is often the case that the user will want to integrate the existing solutions, e.g. an asset management system, with the Mainflux platform. To simplify the integration between the systems and avoid artificial cross-platform reference, such as special fields in Mainflux Things metadata, it is possible to set Mainflux Thing secret with an existing unique secret when creating the Thing. This way, the user can set the existing secret as the Thing secret of a newly created Thing to keep reference between Thing and the asset that Thing represents.
+The limitation is that the existing secret has to be unique in the Mainflux domain.
 
 To create a thing with an external secret, you need to provide the secret together with thing name, and other fields as well as a `user_token`
 
@@ -1357,7 +1357,7 @@ Access-Control-Expose-Headers: Location
 
 ### Create Channel with external ID
 
-Channel is a group of things that could represent a special category in existing systems, e.g. a building level channel could represent the level of a smarting building system. For helping to keep the reference, it is possible to set an existing ID while creating the Magistrala channel. There are two limitations - the existing ID has to be in UUID V4 format and it has to be unique in the Magistrala domain.
+Channel is a group of things that could represent a special category in existing systems, e.g. a building level channel could represent the level of a smarting building system. For helping to keep the reference, it is possible to set an existing ID while creating the Mainflux channel. There are two limitations - the existing ID has to be in UUID V4 format and it has to be unique in the Mainflux domain.
 
 To create a channel with external ID, the user needs to provide a UUID v4 format unique ID, and a `user_token`
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -7,7 +7,7 @@ copyright: Copyright (c) Abstract Machines
 repo_url: https://github.com/absmach/magistrala
 site_description: Magistrala IoT System
 site_name: Magistrala
-site_url: https://docs.mainflux.io
+site_url: https://docs.magistrala.abstractmachines.fr
 edit_uri: ""
 theme:
   name: material