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: Adds notes on Hermes packaging requirements #71

Merged
merged 49 commits into from Mar 5, 2024

Conversation

saibatizoku
Copy link
Contributor

@saibatizoku saibatizoku commented Jan 25, 2024

Description

Adds documentation requirements for packaging Hermes Applications.

Related Issue(s)

List the issue numbers related to this pull request.

#70

Description of Changes

See the generated docs here.

  • Overview
  • Packaging A Hermes Application
  • Defining Application Metadata
  • Static Assets
  • Application Data
  • Application WASM Modules
  • Application Signatures

Please confirm the following checks

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream module

@saibatizoku saibatizoku added the documentation Pull requests that update a dependency file. label Jan 25, 2024
@saibatizoku saibatizoku added this to the M2: Hermes Foundations milestone Jan 25, 2024
@saibatizoku saibatizoku self-assigned this Jan 25, 2024
@saibatizoku saibatizoku linked an issue Jan 25, 2024 that may be closed by this pull request
@saibatizoku saibatizoku added the draft Draft label Jan 25, 2024
@saibatizoku saibatizoku marked this pull request as ready for review January 25, 2024 04:54
@saibatizoku saibatizoku force-pushed the feat/hermes-packaging-docs branch 2 times, most recently from 7b95375 to f59a2f3 Compare January 29, 2024 18:34
@saibatizoku saibatizoku force-pushed the feat/hermes-packaging-docs branch 4 times, most recently from 713d4ba to 376217a Compare February 1, 2024 03:42
Mr-Leshiy
Mr-Leshiy previously approved these changes Feb 8, 2024
Copy link
Contributor

@Mr-Leshiy Mr-Leshiy left a comment

Choose a reason for hiding this comment

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

Looks awesome !

But I have a question about private and public data, maybe it make sense to rename directories to the var/public and var/private instead of var/data, var/www ?
So it will make it more clear and from the packaging perspective we will don't care what exact data should be there, we are just managing the scope to it.

cc @stevenj

@saibatizoku
Copy link
Contributor Author

Looks awesome !

But I have a question about private and public data, maybe it make sense to rename directories to the var/public and var/private instead of var/data, var/www ? So it will make it more clear and from the packaging perspective we will don't care what exact data should be there, we are just managing the scope to it.

cc @stevenj

Thanks! I'm open to renaming the paths, and I considered a similar approach to what you are proposing, but I think that public and private are terms that could lead to confusion, as they have different meanings depending on the context.

In this case, the context is using HDF5 files as a file-system, so using /var/data and /var/www, is similar to the convention in POSIX-based file-systems that should be familiar to most developers.

So, in this case, I would opt for keeping the names as they are, or to find a middle ground.

@stevenj stevenj marked this pull request as draft February 22, 2024 16:22
@stevenj stevenj marked this pull request as ready for review March 1, 2024 16:27
@stevenj stevenj self-assigned this Mar 1, 2024
Copy link
Contributor

@FelipeRosa FelipeRosa left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@bkioshn bkioshn left a comment

Choose a reason for hiding this comment

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

Looks good, the document is clear and understandable 🥳

@stevenj stevenj merged commit 774f86f into main Mar 5, 2024
21 checks passed
@stevenj stevenj deleted the feat/hermes-packaging-docs branch March 5, 2024 03:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests that update a dependency file. draft Draft
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

🛠️ [TASK] : Document Hermes application packaging requirements
5 participants