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.

Sign up for GitHub

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

Jump to bottom

Prepare documentation for Dashboard #94

Merged
merged 10 commits into from
Jan 25, 2022
Merged

Prepare documentation for Dashboard #94

merged 10 commits into from
Jan 25, 2022

Conversation

pkosiec
Copy link
Member

@pkosiec pkosiec commented Jan 20, 2022 •
edited
Loading

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 mentioned this pull request Jan 20, 2022
Closed
7 tasks
@pkosiec pkosiec changed the title Prepare basic Dashboard documentation Prepare documentation for Dashboard Jan 20, 2022
@pkosiec pkosiec mentioned this pull request Jan 21, 2022
Open
mkuziemko
mkuziemko reviewed Jan 25, 2022
View reviewed changes
Copy link

@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.

docs/dashboard-ui/action-management.md Outdated Show resolved Hide resolved
docs/dashboard-ui/action-management.md Outdated Show resolved Hide resolved
docs/dashboard-ui/action-management.md Outdated Show resolved Hide resolved
docs/dashboard-ui/action-management.md Outdated Show resolved Hide resolved
docs/dashboard-ui/overview.md Outdated Show resolved Hide resolved
mkuziemko
mkuziemko approved these changes Jan 25, 2022
View reviewed changes
Copy link

@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
Reviewers

@mkuziemko mkuziemko mkuziemko approved these changes

@mszostok mszostok Awaiting requested review from mszostok mszostok is a code owner

@tmitchell tmitchell Awaiting requested review from tmitchell tmitchell is a code owner

Assignees
No one assigned
Labels
area/dashboard Relates to Dashboard area/documentation Relates to all activities around documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Install Capact Dashboard as a part of Capact installation
2 participants
@pkosiec @mkuziemko