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

simple tree: bare-bones tree view for documentation purposes #1139

Merged
merged 4 commits into from
Apr 24, 2023

Conversation

oliver-sanders
Copy link
Member

@oliver-sanders oliver-sanders commented Nov 17, 2022

Built on #1108

SimpleTree: a simple view a functional documentation

  • A new bare-bones live tree view not available in production mode.
  • Indended to serve as documentation and a guide for future view
    development.

Requirements check-list

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.
  • Contains logically grouped changes (else tidy your branch by rebase).
  • Does not contain off-topic changes (use other PRs for other changes).
  • Appropriate tests are included (ok for laters, this is docs?)
  • No change log entry required (why? e.g. invisible to users).
  • No documentation update required.

@oliver-sanders oliver-sanders added this to the 1.x milestone Nov 17, 2022
@oliver-sanders oliver-sanders self-assigned this Nov 17, 2022
* A new bare-bones live tree view not available in production mode.
* Indended to serve as documentation and a guide for future view
  development.
Comment on lines 111 to 116
if (this.environment !== 'PRODUCTION') {
// dynamically load development views that we don't want in production
import('@/views/SimpleTree').then((SimpleTreeView) => {
this.views.push(SimpleTreeView.default)
})
}
Copy link
Member Author

@oliver-sanders oliver-sanders Dec 1, 2022

Choose a reason for hiding this comment

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

Reviewers: Please check that the SimpleTree is present when the UI is built in dev mode (i.e. build:watch) but not when run in production mode (i.e. build).

Copy link
Member

Choose a reason for hiding this comment

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

Checked, all good.

Copy link
Member

Choose a reason for hiding this comment

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

me too

@oliver-sanders
Copy link
Member Author

Rebased and ready.

@oliver-sanders oliver-sanders marked this pull request as ready for review December 1, 2022 13:07
@oliver-sanders oliver-sanders modified the milestones: 1.x, 1.5.0 Dec 7, 2022
@MetRonnie MetRonnie modified the milestones: 1.5.0, 1.x Jan 25, 2023
@oliver-sanders oliver-sanders modified the milestones: 1.x, 1.6.0 Feb 21, 2023
@oliver-sanders
Copy link
Member Author

No tests for this ATM (functional documentation). Wouldn't object if anyone wanted to write one though...

Resolved Conflicts:
	src/store/workflows.module.js
	src/views/Workspace.vue
@hjoliver
Copy link
Member

hjoliver commented Apr 2, 2023

@oliver-sanders - I've pushed a small conflict resolution commit (merge from master) to your branch.

Copy link
Member

@hjoliver hjoliver left a comment

Choose a reason for hiding this comment

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

Excellent. Nicely documented, works as intended.

@hjoliver
Copy link
Member

hjoliver commented Apr 2, 2023

@MetRonnie or @wxtim - I'm sure this would be a quick review for one of you.

@MetRonnie MetRonnie self-requested a review April 3, 2023 09:50
@MetRonnie
Copy link
Member

The only thing I might suggest is excluding the new file from code coverage?

@MetRonnie MetRonnie changed the base branch from master to 1.6.x April 6, 2023 16:14
src/views/SimpleTree.vue Outdated Show resolved Hide resolved
src/views/SimpleTree.vue Outdated Show resolved Hide resolved
@oliver-sanders oliver-sanders merged commit 968affd into cylc:1.6.x Apr 24, 2023
@oliver-sanders oliver-sanders deleted the simple-tree branch April 24, 2023 14:02
MetRonnie added a commit that referenced this pull request Jun 8, 2023
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.

3 participants