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

docs(ledger-browser): add initial GUI documentation and fix some bugs #3482

Merged
merged 1 commit into from
Sep 4, 2024

Conversation

outSH
Copy link
Contributor

@outSH outSH commented Aug 13, 2024

  • Add new documentation section to project docs. New pages can be found under
    Cactus -> Ledger Browser category. Documentation include GUI setup
    instructions, application overviews, developer guide and tutorial
    on developing new app plugin for the GUI.
  • Do some minor quality of life improvements and bug fixes.
  • Add missing GUI database schema file.
  • Remove dead code from GUI that still used getAppList.
  • Add documentation links to the GUI. For now, most links are empty and they
    will be set once this PR is merged and the docs URLs are confirmed.
  • Add sample tutorial application (the same that is created step-by-step in
    the tutorial in the documentation)
  • Improve plugin app URL regex to allow more valid paths.
  • Expose ethereum and fabric schemas in supabase-all-in-one
  • Extend persistence plugin init SQL with code for exposing custom schemas.
  • Improve supabase-all-in-one readme documentation.
  • Fix persistence sample setup scripts ports so that both scripts can be run
    at the same time.

Depends on #3448
Depends on #3449

Signed-off-by: Michal Bajer michal.bajer@fujitsu.com

Pull Request Requirements

  • Rebased onto upstream/main branch and squashed into single commit to help maintainers review it more efficient and to avoid spaghetti git commit graphs that obfuscate which commit did exactly what change, when and, why.
  • Have git sign off at the end of commit message to avoid being marked red. You can add -s flag when using git commit command. You may refer to this link for more information.
  • Follow the Commit Linting specification. You may refer to this link for more information.

Character Limit

  • Pull Request Title and Commit Subject must not exceed 72 characters (including spaces and special characters).
  • Commit Message per line must not exceed 80 characters (including spaces and special characters).

A Must Read for Beginners
For rebasing and squashing, here's a must read guide for beginners.

Copy link
Contributor

@petermetz petermetz left a comment

Choose a reason for hiding this comment

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

@outSH LGTM, I'm just blocking the merge manually until the parent PRs have been merged because right now the bot that does the enforcement of the dependent PRs seems to be dead (I'm working on an alternative solution: hyperledger/governance#314 )

Please re-request review when the parent PRs are merged, no actual change is necessary from my side.

@outSH outSH force-pushed the gui_documentation_pr branch from 958dcef to 2d5a6e9 Compare August 14, 2024 11:05
@outSH outSH requested a review from petermetz August 14, 2024 11:06
@RafaelAPB
Copy link
Contributor

+1, cool work! This will be handy to the other packages as well

Copy link
Contributor

@VRamakrishna VRamakrishna left a comment

Choose a reason for hiding this comment

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

LGTM. Can we revisit the envisioned integrated architecture (in ROADMAP.md) and see where the ledger browser and the supabase fit in? We can open an issue for discussion on this, and I can update the architecture diagram accordingly.

- Add new documentation section to project docs. New pages can be found under
    `Cactus` -> `Ledger Browser` category. Documentation include GUI setup
    instructions, application overviews, developer guide and tutorial
    on developing new app plugin for the GUI.
- Do some minor quality of life improvements and bug fixes.
- Add missing GUI database schema file.
- Remove dead code from GUI that still used `getAppList`.
- Add documentation links to the GUI. For now, most links are empty and they
    will be set once this PR is merged and the docs URLs are confirmed.
- Add sample tutorial application (the same that is created step-by-step in
    the tutorial in the documentation)
- Improve plugin app URL regex to allow more valid paths.
- Expose ethereum and fabric schemas in supabase-all-in-one
- Extend persistence plugin init SQL with code for exposing custom schemas.
- Improve supabase-all-in-one readme documentation.
- Fix persistence sample setup scripts ports so that both scripts can be run
    at the same time.

Depends on hyperledger-cacti#3448
Depends on hyperledger-cacti#3449

Signed-off-by: Michal Bajer <michal.bajer@fujitsu.com>
@petermetz petermetz force-pushed the gui_documentation_pr branch from 2d5a6e9 to 1513c4e Compare September 4, 2024 22:08
@petermetz petermetz merged commit bdc5cd7 into hyperledger-cacti:main Sep 4, 2024
147 checks passed
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.

4 participants