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

VUU83: Layout management documentation #98

Closed
wants to merge 4 commits into from
Closed

VUU83: Layout management documentation #98

wants to merge 4 commits into from

Conversation

cfisher-scottlogic
Copy link

Description

Adds documentation to the main project README for persisting layouts.

Change List

  • Write steps for choosing local/remote & how to run the remote server
  • Advise on URLs for accessing swagger and database
  • Move IntelliJ configuration section above client installation
  • Refactor whole README with suggested changes from markdown-lint

Closes #83

@cfisher-scottlogic cfisher-scottlogic added the documentation Improvements or additions to documentation label Nov 6, 2023
@cfisher-scottlogic
Copy link
Author

cfisher-scottlogic commented Nov 6, 2023 •
edited

How do we want to go about updating the Vuu docs? I'm uncomfortable with persisting two separate versions of this advice, as it creates the opportunity for them to become out of sync. But, I'm not sure how to get around this, except by just linking to one from the other?

My proposal would be to move all of the advice in this README to the Vuu docs, and keep that as the source of truth for all things Vuu including dev setup.

vferraro-scottlogic
vferraro-scottlogic approved these changes Nov 6, 2023
View reviewed changes
Copy link

@vferraro-scottlogic vferraro-scottlogic left a comment

Choose a reason for hiding this comment

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

LGTM

@cfisher-scottlogic
Copy link
Author

cfisher-scottlogic commented Nov 14, 2023 •
edited

@vferraro-scottlogic @pling-scottlogic Are we happy for me to change the base branch of this PR to finos:main?

I've reset the branch to finos:main and cherry-picked the 2 relevant commits.

@cfisher-scottlogic cfisher-scottlogic changed the base branch from main to VUU333-layout-server November 20, 2023 10:54
@cfisher-scottlogic
Copy link
Author

@vferraro-scottlogic @pling-scottlogic Are we happy for me to change the base branch of this PR to finos:main?

I've reset the branch to finos:main and cherry-picked the 2 relevant commits.

Will wait till finos#970 has gone in.

@cfisher-scottlogic
Copy link
Author

cfisher-scottlogic commented Nov 21, 2023 •
edited

Opened a PR on the finos fork (finos#990)

@cfisher-scottlogic cfisher-scottlogic mentioned this pull request Nov 21, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vferraro-scottlogic vferraro-scottlogic vferraro-scottlogic approved these changes

@pling-scottlogic pling-scottlogic pling-scottlogic approved these changes

@heswell heswell Awaiting requested review from heswell

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation for remote layout management server
3 participants
@cfisher-scottlogic @pling-scottlogic @vferraro-scottlogic