Skip to content

Overhaul Docs Structure#21

Merged
elliot-huffman merged 29 commits intomainfrom
SHIELD-Reorganization
Apr 3, 2025
Merged

Overhaul Docs Structure#21
elliot-huffman merged 29 commits intomainfrom
SHIELD-Reorganization

Conversation

@elliot-huffman
Copy link
Contributor

@elliot-huffman elliot-huffman commented Jan 15, 2025

Restructure the SHI Lab docs to support the new SHIELD product structure.
Add a place holder for the upcoming Cloud Matrix product.
Add a place holder for the SHI Data Gateway system so that it can be publicly documented properly.

Todo:

  • Update the content of the files to reflect their new locations.
  • Update the getting started guides so that they reflect their new product sections.
  • Merge the getting started folder into the top-level SHIELD index.md docs to eliminate a need for special docs for getting started with the platform.

Restructure the SHIELD products into their respective Deploy, Defend and Discover components rather than one hodgepodge of SHIELD all up.
Additionally, add a place holder for the cloud matrix that will be built at some future date.
Kh4lil and others added 26 commits January 17, 2025 13:31
Remove hard coded nav menu
Update copyright to 2025
Remove GitHub link
Move deploy getting started files.
@Kh4lil Kh4lil force-pushed the SHIELD-Reorganization branch from f081515 to 4e97850 Compare April 3, 2025 20:09
@elliot-huffman elliot-huffman marked this pull request as ready for review April 3, 2025 22:23
Copilot AI review requested due to automatic review settings April 3, 2025 22:23
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 122 out of 122 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (2)

docs/SHIELD/Defend/Reference/Diagrams/Device-Commission.md:7

  • Verify that the updated relative path correctly points to the new location of the commissioning guide given the restructured docs.
+The lifecycle management engine is responsible for a variety of tasks. Below is the flowchart of the logical process that is completed when a device is [commissioned](../../Usage-Guide/Device/0-Commission.md).

docs/SHIELD/Defend/Reference/Diagrams/Device-Assign.md:7

  • Confirm that the new link path correctly directs users to the updated device assignment guide location in the restructured documentation.
+The lifecycle management engine is responsible for a variety of tasks. Below is the flowchart of the logical process that is completed when a device is [assigned one or more users](../../Usage-Guide/Device/2-Assign.md).

@socket-security
Copy link

Updated dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
pypi/mkdocs-material@9.6.99.6.11 None 0 13.6 MB squidfunk

View full report↗︎

@socket-security
Copy link

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert Package NoteSourceCI
Uses eval pypi/mkdocs-material@9.6.11 ⚠︎
Uses eval pypi/mkdocs-material@9.6.11 ⚠︎

View full report↗︎

Next steps

What is dynamic code execution?

Package uses dynamic code execution (e.g., eval()), which is a dangerous practice. This can prevent the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Avoid packages that use dynamic code execution like eval(), since this could potentially execute any code.

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/foo@1.0.0 or ignore all packages with @SocketSecurity ignore-all

  • @SocketSecurity ignore pypi/mkdocs-material@9.6.11

@elliot-huffman elliot-huffman removed their assignment Apr 3, 2025
@elliot-huffman elliot-huffman merged commit 3149a9b into main Apr 3, 2025
5 checks passed
@elliot-huffman elliot-huffman deleted the SHIELD-Reorganization branch April 3, 2025 22:31
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.

4 participants