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

docs: comments in the api/conf/config.yaml need to be aligned #967

Closed
membphis opened this issue Dec 5, 2020 · 4 comments · Fixed by #969
Closed

docs: comments in the api/conf/config.yaml need to be aligned #967

membphis opened this issue Dec 5, 2020 · 4 comments · Fixed by #969
Assignees
Labels
backend documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@membphis
Copy link
Member

membphis commented Dec 5, 2020

The current comment style is not good to read.

They should be aligned for easy reading.

we should use a better style, here is an example:

conf:
  listen:
    host: 127.0.0.1     # `manager api` listening ip or host name
    port: 9000          # `manager api` listening port
  etcd:
    endpoints:          # supports defining multiple etcd host addresses for an etcd cluster
      - 127.0.0.1:2379
  log:
    error_log:
      level: warn       # supports levels, lower to higher: debug, info, warn, error, panic, fatal
      file_path:
        logs/error.log  # supports relative path, absolute path, standard output
                        # such as: logs/error.log, /tmp/logs/error.log, /dev/stdout, /dev/stderr
authentication:
  secret:
    secret              # secret for jwt token generation.
                        # NOTE: Highly recommended to modify this value to protect `manager api`.
                        # if it's default value, when `manager api` start , it will generate a random string to replace it.
  expire_time: 3600     # jwt token expire time, in second
  users:
    - username: admin   # username and password for login `manager api`
      password: admin
    - username: user
      password: user
@membphis membphis added documentation Improvements or additions to documentation good first issue Good for newcomers backend labels Dec 5, 2020
@96RadhikaJadhav
Copy link
Contributor

@membphis Could you please assign the issue to me? I wish to work on it.

@nic-chen
Copy link
Member

nic-chen commented Dec 5, 2020

@membphis Could you please assign the issue to me? I wish to work on it.

that's great. thanks.

@96RadhikaJadhav
Copy link
Contributor

@membphis Could you please review my PR?

@membphis
Copy link
Member Author

membphis commented Dec 6, 2020

@membphis Could you please review my PR?

I have reviewed ^_^

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

Successfully merging a pull request may close this issue.

3 participants