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

Document new STAC Manager #21

Closed
10 tasks done
Tracked by #18
j08lue opened this issue Dec 17, 2024 · 1 comment · Fixed by #18
Closed
10 tasks done
Tracked by #18

Document new STAC Manager #21

j08lue opened this issue Dec 17, 2024 · 1 comment · Fixed by #18
Assignees
@danielfdsilva
Labels
documentation Improvements or additions to documentation
Milestone
STAC Manager MVP

Comments

@j08lue
Copy link
Member

j08lue commented Dec 17, 2024 •
edited
Loading

The new architecture for STAC Manager is taking shape and the new app has feature parity with the original STAC Admin.

Before we merge the re-implementation, a few things should get documented (list from @danielfdsilva), so we deliver a usable and understandable solution:

  • What is a plugin and what is it used for?
  • Creating a plugin: The schema (describe all the options)
  • Creating a plugin: how the schema maps to default widgets / how to set a custom widget
  • Creating a plugin: Enter/exit data
  • Creating a plugin: Utility functions
  • Widgets: Existent ones
  • Widgets: Creating custom widgets
  • Client Form: Requirements to implement
  • Client Form: Creating the form (useCollectionPlugins, PluginBox, WidgetRenderer)
  • Client Form: Validation and data submission
@j08lue j08lue added the documentation Improvements or additions to documentation label Dec 17, 2024
@j08lue j08lue mentioned this issue Dec 17, 2024
Merged
2 tasks
@j08lue j08lue added this to the MVP milestone Feb 25, 2025
danielfdsilva added a commit that referenced this issue Feb 26, 2025
@danielfdsilva
Improve system documentation
1840081 
Fix #21
@j08lue
Copy link
Member Author

j08lue commented Feb 27, 2025

The new docs in https://github.com/developmentseed/stac-manager/tree/stac-manager/docs seem to cover all the mentioned topics and look well laid out. I cannot speak to how user-friendly they are for developers or contributors, but definitely work for closing this as completed on the PR is merged.

@j08lue j08lue linked a pull request Feb 27, 2025 that will close this issue
Rewrite application with form plugin system and new design #18
Merged
2 tasks
@j08lue j08lue closed this as completed Mar 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@danielfdsilva danielfdsilva

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
STAC Manager MVP
Development

Successfully merging a pull request may close this issue.

Rewrite application with form plugin system and new design developmentseed/stac-manager
2 participants
@danielfdsilva @j08lue