Skip to content

Prepare documentation for Dashboard#94

Merged
pkosiec merged 10 commits intocapactio:mainfrom
pkosiec:ui-docs
Jan 25, 2022
Merged

Prepare documentation for Dashboard#94
pkosiec merged 10 commits intocapactio:mainfrom
pkosiec:ui-docs

Conversation

@pkosiec
Copy link
Copy Markdown
Collaborator

@pkosiec pkosiec commented Jan 20, 2022

Description

Changes proposed in this pull request:

  • Prepare Overview document for Dashboard
  • Include Dashboard in E2E architecture document

Additional scope:

  • Prepare Action management document

  • Refactor redirects script to make it easier to maintain redirects

    • Update release script
    • See how it looked before refactor: 23f1a3d
  • create follow-up task for refactoring existing docs to show Dashboard as an alternative: Prepare documentation for Dashboard #94

Testing

See new docs and test redirections on https://ui-docs.capact-website.pages.dev/docs/next/dashboard-ui/overview

To test new redirections after release:

  1. Checkout this branch
  2. Edit hack/make-release.sh script and comment line 24 (git push origin main)
  3. Run:
RELEASE_VERSION=0.6.0 ./hack/make-release.sh
  1. See the last commit
  2. Run npm run build and npm run serve and test redirects

Related issue(s)

Resolves capactio/capact/issues/599

@pkosiec pkosiec added enhancement New feature or request area/documentation Relates to all activities around documentation area/dashboard Relates to Dashboard labels Jan 20, 2022
@pkosiec pkosiec changed the title Prepare basic Dashboard documentation Prepare documentation for Dashboard Jan 20, 2022
Copy link
Copy Markdown
Collaborator

@mkuziemko mkuziemko left a comment

Choose a reason for hiding this comment

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

Looks really good. Small suggestions added.

Comment thread docs/dashboard-ui/action-management.md Outdated
Comment thread docs/dashboard-ui/action-management.md Outdated
Comment thread docs/dashboard-ui/action-management.md Outdated
Comment thread docs/dashboard-ui/action-management.md Outdated
Comment thread docs/dashboard-ui/overview.md Outdated
Copy link
Copy Markdown
Collaborator

@mkuziemko mkuziemko left a comment

Choose a reason for hiding this comment

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

LGTM 🥇

@pkosiec pkosiec merged commit 91cfbc5 into capactio:main Jan 25, 2022
@pkosiec pkosiec deleted the ui-docs branch January 25, 2022 11:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/dashboard Relates to Dashboard area/documentation Relates to all activities around documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Install Capact Dashboard as a part of Capact installation

2 participants