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

[Story] Document Topology view #106

Closed
11 tasks done
Tracked by #102
andrewazores opened this issue Apr 27, 2023 · 4 comments · Fixed by #118
Closed
11 tasks done
Tracked by #102

[Story] Document Topology view #106

andrewazores opened this issue Apr 27, 2023 · 4 comments · Fixed by #118
Assignees
@tthvo
Labels
docs Improvements or additions to documentation feat New feature or request

Comments

@andrewazores
Copy link
Member

andrewazores commented Apr 27, 2023 •
edited by tthvo
Loading

  • Navigate
    • Switch layout. [Graph] Control bar. [List] Click to expand.
    • Update display options
    • Open detail drawer
    • Switch tab on detail drawer panel (need explanation for each tab).
  • Actions
    • Target action
    • Group action
  • Custom Target
    • Create a CT
    • Delete a CT
@andrewazores andrewazores added feat New feature or request docs Improvements or additions to documentation labels Apr 27, 2023
@andrewazores andrewazores moved this to Todo in 2.3.0 release Apr 27, 2023
@andrewazores
Copy link
Member Author

@tthvo do you have time/interest in this?

@andrewazores andrewazores mentioned this issue Apr 27, 2023
Closed
4 tasks
@tthvo
Copy link
Member

tthvo commented Apr 27, 2023

Yeh sure I can take this on! What do you think we should document here?

@andrewazores andrewazores changed the title [Task] Document Topology view [Story] Document Topology view Apr 27, 2023
@andrewazores
Copy link
Member Author

Basically just the tasks that the user might want to achieve on the view, ie. seeing the layout of everything, seeing an overview of resources, performing bulk actions, defining custom targets. Each of those can be a separate guide with some shared reusable sections about visiting the Topology view, similar to how existing guides have shared elements about "navigate to Recordings" or "navigate to Events".

@tthvo tthvo self-assigned this Apr 27, 2023
@tthvo tthvo moved this from Todo to In Progress in 2.3.0 release Apr 27, 2023
@tthvo
Copy link
Member

tthvo commented Apr 27, 2023

Cool thanks! I probably use this as a scaffold for downstream docs too.

@tthvo tthvo mentioned this issue May 16, 2023
Merged
@tthvo tthvo linked a pull request May 16, 2023 that will close this issue
feat(topology): document topology view and custom target form #118
Merged
@tthvo tthvo closed this as completed May 17, 2023
@github-project-automation github-project-automation bot moved this from In Progress to Done in 2.3.0 release May 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tthvo tthvo

Labels
docs Improvements or additions to documentation feat New feature or request
Projects
No open projects
2.3.0 release
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(topology): document topology view and custom target form tthvo/cryostatio.github.io
2 participants
@andrewazores @tthvo