Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NOISSUE - Rename Magistrala to SuperMQ in docs repo #205

Merged
merged 12 commits into from
Dec 11, 2024

Conversation

Musilah
Copy link
Contributor

@Musilah Musilah commented Dec 9, 2024

Pull request title should be MG-XXX - description or NOISSUE - description where XXX is ID of issue that this PR relate to.
Please review the CONTRIBUTING.md file for detailed contributing guidelines.

What does this do?

This PR renames the magistrala docs to superMQ

Which issue(s) does this PR fix/relate to?

Put here Resolves #XXX to auto-close the issue that your PR fixes (if such)
N/A

List any changes that modify/break current functionality

  • Rename Magistrala to SuperMQ in the Docs
  • Update links and images for SuperMQ
  • Switch to Docusaurus for Documentation from MkDocs
  • Update the Homepage and Blogs for new Docusaurus

Have you included tests for your changes?

No

Did you document any new/modified functionality?

Yes

Notes

New SuperMQ docs Homepage:

image

image

Docs Page with sidebar:

image

image

Blogs page:

image

image

@Musilah Musilah marked this pull request as ready for review December 9, 2024 10:13
Signed-off-by: Musilah <[email protected]>
Copy link

@wambui-pixel wambui-pixel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Logo is too small
image

Copy link

@wambui-pixel wambui-pixel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the on-hover is a bit too dark
image

Copy link

@wambui-pixel wambui-pixel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. The logo is bigger in dark mode
  2. The active color is not easily visible

image

Copy link

@wambui-pixel wambui-pixel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Increase the size, especially of the home logo
  2. This font headers look a bit off.
  3. We should switch this image to one that uses superMQ, and not Mainflux

image

docusaurus.config.ts Outdated Show resolved Hide resolved
docusaurus.config.ts Show resolved Hide resolved
docusaurus.config.ts Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
static/CNAME Show resolved Hide resolved
static/.nojekyll Outdated Show resolved Hide resolved
static/img/docusaurus-social-card.jpg Outdated Show resolved Hide resolved
docs/opcua.md Outdated Show resolved Hide resolved
docs/provision.md Outdated Show resolved Hide resolved
docs/tracing.md Outdated Show resolved Hide resolved
docs/lora.md Outdated Show resolved Hide resolved
Copy link

@felixgateru felixgateru left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

check whether you can have this rendered as go code similar to what is in mkdocs as well as other instances

Signed-off-by: Musilah <[email protected]>
Signed-off-by: Musilah <[email protected]>
@dborovcanin
Copy link
Contributor

image
Rename The Scalable, Secure IoT Cloud Platform to Event-driven Infrastructure for Modern Cloud and Scalable IoT Middleware to Scalable Messaging Middleware.

@dborovcanin
Copy link
Contributor

image
Group the sidebar in the following manner:

Overview

Architecture

Concepts

  • Entities
  • Authentication
  • Authorization
  • Security
  • Messaging

Getting Started

  • API
  • CLI

Developer's guide

  • Events
  • Tracing

Storage

Edge

Certs

Kubernetes

SMQ-Contrib Repository

  • LoRa
  • OPC-UA
  • Provision
  • Twins Service
  • Bootstrap

Test Spec

Also, please update Storage links, since some of those addons are now in the contrib repo.

Signed-off-by: Musilah <[email protected]>
Signed-off-by: Musilah <[email protected]>
Copy link
Contributor

@dborovcanin dborovcanin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please change section titles to avoid duplications:
image
Something like Overview will work, but try to think of something better, ideally different for each subsection.

@dborovcanin dborovcanin merged commit 09551be into absmach:main Dec 11, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants