-
Notifications
You must be signed in to change notification settings - Fork 11
Closed
Labels
Description
Context:
As we iterate on the registry's initial version, we aim to refine the structure and organization of the app schema files to enhance maintainability and usability.
Follows #65 and @jeronimoalbi's suggestion in particular.
Acceptance Criteria:
- Directory Structure: Avoid using separate folders for each app schema unless necessary for additional content like images or documents. Propose storing all schemas at the same level within a renamed directory, enhancing file management and access.
- File Naming and Formats: Standardize the naming of schema files using a format such as
foo_name.app.json. Consider the flexibility of supporting both JSON and YAML formats to accommodate different developer preferences. - Registry and Schema Files: Transition from
schema.app.jsontoregistry.jsonto clarify its role as the main registry file, with individual app schemas using the.app.jsonsuffix. Additionally, define a straightforward JSON schema (schema.json) to validate the app schemas. - Folder Naming: Rename
_ignite-app-registrytoregistry, simplifying the URL tohttps://github.com/ignite/apps/registryand improving semantic clarity. - Schema Simplicity and Evolution: Maintain a simple schema initially, incorporating only necessary features. Expand the schema dynamically based on real-world use and developer feedback.
Notes:
- Look to established standards like
package.jsonandpyproject.tomlfor best practices in schema design. - For defining the schema validation, refer to the JSON Schema official documentation.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Type
Projects
Status
Done