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

Streamlining Access Tokens for Developers #20

Open
geoffreygarrett opened this issue Feb 13, 2023 · 1 comment
Open

Streamlining Access Tokens for Developers #20

geoffreygarrett opened this issue Feb 13, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@geoffreygarrett
Copy link
Member

Problem Statement:

Developers need to efficiently manage access tokens for Azure, GitHub, and Anaconda cloud. This is especially difficult for those with backgrounds in non-software engineering fields who are unfamiliar with DevOps, version control, and related concepts. The goal of this document is to provide clear and concise guidance on obtaining and updating access tokens, with a focus on ease of use for developers with limited time.

Requirements:

  • Familiarity with environment variables on their relevant OS (Linux, MacOS, Windows)
  • General understanding of the importance of defining token permissions for safety
  • Knowledge of the purpose of the services offered by GitHub, Azure, and Anaconda Cloud

Deliverables:

  • Overview of access tokens and their importance
  • Clear instructions for generating tokens on Azure and GitHub
  • Steps for maintaining tokens and updating them as needed
  • Code snippets for UNIX and Windows to demonstrate the use of named tokens from the environment
  • Admonitions to highlight important information
  • Summary of information covered in the document
  • Final thoughts and recommendations

Formatting:

  • Use clear language and concise instructions
  • Provide images to accompany steps for a visual guide
  • Differentiate between MacOS and Ubuntu only if necessary
@geoffreygarrett geoffreygarrett added the documentation Improvements or additions to documentation label Feb 13, 2023
@geoffreygarrett geoffreygarrett self-assigned this Feb 13, 2023
@geoffreygarrett geoffreygarrett changed the title Streamlining Access Tokens for Developers Streamlining Access Tokens for Developers Feb 13, 2023
geoffreygarrett added a commit that referenced this issue Feb 13, 2023
- Added problem statement and target audience
- Added prior requirements for reader understanding and ease of use
- Outlined the general structure
- Completed user token generation for GitHub
geoffreygarrett added a commit that referenced this issue Feb 14, 2023
- Added problem statement and target audience
- Added prior requirements for reader understanding and ease of use
- Outlined the general structure
- Completed user token generation for GitHub
geoffreygarrett added a commit that referenced this issue Feb 14, 2023
- Refactored guide to be more Problem-oriented and straightforward
geoffreygarrett added a commit that referenced this issue Feb 14, 2023
geoffreygarrett added a commit that referenced this issue Feb 14, 2023
Added guides on defining variables in:
- Python
- Windows
- Unix
- Azure
@geoffreygarrett
Copy link
Member Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant