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

Update chip support pages #376

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

f-hollow
Copy link
Collaborator

@f-hollow f-hollow commented Jan 2, 2025

Description

The following updates are planned:

  • The dynamically fetched file .md is turned into .json with a number of key-value pairs.
    • Features in markdown
    • Other projects in markdown
    • Timestamp when info was generated
  • These fields will be populated in different places of chip support pages.

Related

Testing


Checklist

Before submitting a Pull Request, please ensure the following:

  • 🚨 This PR does not introduce breaking changes.
  • All CI checks (GH Actions) pass.
  • Documentation is updated as needed.
  • Tests are updated or added as necessary.
  • Code is well-commented, especially in complex areas.
  • Git history is clean — commits are squashed to the minimum necessary.

@horw
Copy link
Member

horw commented Jan 2, 2025

Hi!

I think it’s an interesting topic to discuss where you load your JSON files from.
There are a few options:

  • Load them under your domain.
  • Load them under another trusted domain.
  • Load them from any domain.

Another question is how you control your JSON versions. Do you want to manage their changes, or not at all?

If we don’t rely on third-party APIs and our JSON files are just semi-static metadata, it’s a good idea to minimize the number of sources. For example, storing them on the same domain can simplify things. This eliminates the need to deal with CORS issues. However, in this case, we must carefully review what we upload to our server and ensure that the files are not accidentally removed, on the other hand, we also need to consider the limitations on who can upload these files.

Regarding the limitations mentioned above, a dedicated repository can help us solve these issues. We can create a repository, such as a specification files(just example) repository, to hold the files. After a review, updates could be pushed to the server via a workflow pipeline. This approach ensures that the files are reviewed, maintains a centralized location for restoration, streamlines the update process, and ensures that only the pipeline has access to push files.

@f-hollow f-hollow force-pushed the feat/update_chip_support_pages branch 10 times, most recently from 1c6cb9e to f6e0d28 Compare January 2, 2025 11:36
@f-hollow
Copy link
Collaborator Author

f-hollow commented Jan 2, 2025

Hi!

I think it’s an interesting topic to discuss where you load your JSON files from. There are a few options:

* Load them under your domain.

* Load them under another trusted domain.

* Load them from any domain.

Another question is how you control your JSON versions. Do you want to manage their changes, or not at all?

If we don’t rely on third-party APIs and our JSON files are just semi-static metadata, it’s a good idea to minimize the number of sources. For example, storing them on the same domain can simplify things. This eliminates the need to deal with CORS issues. However, in this case, we must carefully review what we upload to our server and ensure that the files are not accidentally removed, on the other hand, we also need to consider the limitations on who can upload these files.

Regarding the limitations mentioned above, a dedicated repository can help us solve these issues. We can create a repository, such as a specification files(just example) repository, to hold the files. After a review, updates could be pushed to the server via a workflow pipeline. This approach ensures that the files are reviewed, maintains a centralized location for restoration, streamlines the update process, and ensures that only the pipeline has access to push files.

@ginkgm

@f-hollow
Copy link
Collaborator Author

f-hollow commented Jan 3, 2025

@ginkgm Direct link to the ESP32-C61 chip support page:

https://preview-developer.espressif.com/pr376/pages/chip-support-status/esp32c61/

@f-hollow f-hollow force-pushed the feat/update_chip_support_pages branch from 6d4e14e to 7e7fcf1 Compare January 9, 2025 11:59
@f-hollow f-hollow force-pushed the feat/update_chip_support_pages branch from 7e7fcf1 to 9ce9000 Compare January 9, 2025 12:04
Copy link

🎉 A preview for this PR is available at: https://preview-developer.espressif.com/pr376/

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.

2 participants