influxdata / influxdata/docs-v2

List or explain the authorizations and permissions required

Open
#4,541 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

InfluxDB v2 product:v2
Dominant language
JavaScript
Stars
82
Forks
326
Avg merge
1d 1h
Merged PRs (30d)
82

Description

Specifically for create user, but I think it would be helpful to have a standard page section
that names the required permissions for performing the steps. Or, a standard intro on all guides that explains/links to how to use tokens, set CLI config, etc.

Doc the Docs Bot
APP [3:50 PM](https://influxdata.slack.com/archives/C03HRU09PHA/p1665089400264089)
New user feedback!
Page: https://docs.influxdata.com/influxdb/v2.4/users/create-user/
Feedback: Missing authorization steps!!! -t

##### Relevant URLs
- https://docs.influxdata.com/influxdb/v2.4/users/create-user/
- _Provide other relevant URLs (project issues, community threads, etc.)_

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked InfluxDB v2.4 create-user guide and review how it currently describes the steps. Document the permissions required to create a user, and clarify token use and CLI configuration where relevant; done means a reader can identify the required authorization before following the guide.

Written by the indexing model from the issue text.

Assessment

Domain
authentication, authorization, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.