Polykey-Docs: Getting-Started-Documentation #72
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 tasks
|
See #71 (comment). And also ensure that you be rebase squashed and follow conventional commit standard: https://www.conventionalcommits.org/en/v1.0.0/ |
|
Current state of staging is now in production. Ignore the current staging failure is that occurs because the branch is already up to date. |
…es and using env command
CryptoTotalWar
force-pushed
the
getting-started-finalized
branch
from
d734868 to
64baf0c
Compare
|
Just rebased this feature branch off of the staging branch which had changes. |
|
For the managing env variables I am inclined to create a simple demo project that would typically have a .env file and move these env variables to a vault instead that will be injected. Following the following guidelines: https://www.phind.com/search?cache=vjacfmn8ykb7e652jukukkxm |
Refine the tutorial on claiming digital identities in Polykey. Include detailed steps for authentication with GitHub, claiming an identity, and verifying the claim. Add a note on the possibility of claiming multiple identities for different nodes.
- Revise the entire tutorial for claiming digital identities to enhance clarity and user guidance. - Add images to demonstrate key steps in the GitHub authentication process and illustrate the concept of gestalt graphs. - Include detailed explanations of permissions used during the GitHub authentication. - Improve the verification steps to ensure users can confidently verify their identity claims. - Expand the discussion on gestalt graphs, including their operational dynamics and the benefits of federated identities.
Update the section on claiming multiple identities to clarify that multiple nodes can claim the same GitHub identity and that a single node can link to multiple identity providers. Revise the document title to 'Claiming Digital Identities: Establishing Identity Linkages in Polykey' to better reflect the content and impact.
Update the documentation to enhance clarity and accuracy in the identity authentication and claim sections. Include detailed command usage, provide examples for verifying authenticated identities, and adjust the descriptions to better explain the management of multiple identities across nodes and IdPs. Improve navigational instructions for gist verification and incorporate feedback on security and privacy considerations.
Add detailed explanations of gestaltId and permissions within the 'Discovering Users' Nodes and Managing Access Permissions' section. Include examples and syntax clarifications to improve understanding and implementation of node interactions and access controls.
|
This PR is not triggering the CI because it doesn't have the right branch name it should be |
Expand the Sharing Vaults With Secrets documentation to include detailed steps for sharing, scanning, cloning, and synchronizing vaults. Add troubleshooting guidelines and link back to prerequisites from the Discovering Users' Nodes and Managing Access Permissions section for a streamlined user experience. Include code examples for each critical operation and emphasize debugging techniques for common sharing issues.
…d node designation Update the 'Managing Multiple Nodes' tutorial to enhance readability and practical application. Rename 'nodeA' to 'nodeB' to align with Shell B designation, streamline environment configuration steps, and clarify the process of sharing vaults between nodes. These changes aim to simplify the tutorial's execution and improve its educational value for new Polykey users.
|
Revise the tutorial page for to include comprehensive usage examples and explanations of dynamic environment variable management. Enhance sections covering secure environment variable injection, output formats, handling name conflicts, and integrating with cloud services. Add detailed examples for each use case to guide users on effectively applying the command across different contexts.
Enhance the README documentation for the Polykey CLI tutorials page by restructuring the overview, clarifying the supported platforms, and providing a more organized guide through the tutorial sections. Include links to further resources for user engagement and outline advanced scenarios to prepare users for comprehensive usage of Polykey's features.
|
Closing PR as it had the incorrect branch name, created a new PR for this here #75 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR will be for fleshing out the tutorials / Polykey-CLI
Issues Fixed
Tasks
Final checklist