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

Improvements / adjustments for the steps in README #32

Closed
Artur-UX-Designer opened this issue Mar 21, 2023 · 0 comments · Fixed by #101
Closed

Improvements / adjustments for the steps in README #32

Artur-UX-Designer opened this issue Mar 21, 2023 · 0 comments · Fixed by #101
Labels
Priority: low Type: documentation Changes to documentation only (e.g. README.md).

Comments

@Artur-UX-Designer
Copy link

Artur-UX-Designer commented Mar 21, 2023

We should fix details on steps described below (Changes are also relevant for other languages).

Adjustments on the followng "problem" steps:

  1. Skip the quickstart wizard and go directly to User API key creation
    Problem: Link gets user to the User settings page and user should look for a “User API key table”
    Solution: Redesign text to something “Skip the quickstart wizard and go directly to the User settings for creating your own API key".

  2. Create a Bright API key (check out our docs on how to create a user key)
    Problem: Link does not have an anchor link to the correct section. Duplication info from previous step.
    Solution: Fix the link (Add correct anchor to the relevant title). Possible merge steps 2 and 3 into one.

  3. Save the Bright API key
    Problem: Path “Settings > Security > Secrets > Actions” is an old link (it’s redesigned in GitHub). Also it’s hard to find from first glance
    Solution: New path should be “Settings > Secrets and variables > Actions”. TBD - Possibility to design this new path as a link.

    Problem: No info in description that user should create new repository secret.
    Solution: Add clear steps:

    • Create new repository with name BRIGHT_TOKEN (We use this name for ENV var)
    • Paste your API key as secret.
  4. Running in a CI pipeline
    Problem: Path “Settings > Security > Secrets > Actions” is an old link
    Solution: Clear steps should be:

    • Go to “Actions secrets and variables”
    • Activate “Variables” tab

Feel free to reach me on slack to go over this.

@derevnjuk derevnjuk added Type: documentation Changes to documentation only (e.g. README.md). Priority: low labels Mar 21, 2023
pmstss added a commit that referenced this issue Oct 21, 2024
@pmstss pmstss changed the title Improvemts / adjustments for the steps Improvements / adjustments for the steps in README Oct 21, 2024
pmstss added a commit that referenced this issue Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: low Type: documentation Changes to documentation only (e.g. README.md).
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants