Skip to content

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
Collaborator

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
@f-hollow f-hollow mentioned this pull request Jan 22, 2025
3 tasks
@ginkgm
Copy link
Contributor

ginkgm commented Jan 22, 2025

LGTM!

@f-hollow
Copy link
Collaborator Author

@horw Following your suggestions, me and @ginkgm agreed to create two workflows for deploying chip status files:

  • For status files generation repo: Auto-push latest JSON files to production
  • For devportal repo: Pull latest JSON files from the status files generation repo to previews

@f-hollow f-hollow merged commit 7563319 into espressif:main Jan 23, 2025
4 checks passed
@f-hollow f-hollow deleted the feat/update_chip_support_pages branch January 23, 2025 07:40
@horw
Copy link
Collaborator

horw commented Jan 23, 2025

@horw Following your suggestions, me and @ginkgm agreed to create two workflows for deploying chip status files:

  • For status files generation repo: Auto-push latest JSON files to production
  • For devportal repo: Pull latest JSON files from the status files generation repo to previews

Sounds great!

@f-hollow f-hollow mentioned this pull request Feb 24, 2025
6 tasks
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.

3 participants