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] Update configuration information for 2.4.x releases #6047

Merged
merged 2 commits into from
Jan 18, 2020

Conversation

Jennifer88huang-zz
Copy link
Contributor

@Jennifer88huang-zz Jennifer88huang-zz commented Jan 14, 2020

Motivation

Some parameters are added in the broker.conf and standalone.conf files. However, those parameters are not updated in the docs.
See the following PRs for details: #4150, #4066, #4197, #3819, #4261, #4273, #4320.

Modifications

Add those parameter info, and sync docs with the code.

Does not update the description quite much, there are two reasons for this:

  1. Keep doc content consistent with code. We need to update the description for those parameters in the code first, and then sync them in docs.
  2. Will adopt a generator to generate those content automatically in the near future.

@Jennifer88huang-zz Jennifer88huang-zz changed the title [docs] Update configuration information [docs] Update configuration information for 2.4.0 release Jan 14, 2020
@Jennifer88huang-zz Jennifer88huang-zz changed the title [docs] Update configuration information for 2.4.0 release [docs] Update configuration information for 2.4.x releases Jan 14, 2020
@Jennifer88huang-zz Jennifer88huang-zz self-assigned this Jan 14, 2020
@Jennifer88huang-zz Jennifer88huang-zz added area/config doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. labels Jan 14, 2020
@sijie
Copy link
Member

sijie commented Jan 17, 2020

retest this please

@sijie sijie merged commit 6f713a1 into apache:master Jan 18, 2020
@Jennifer88huang-zz Jennifer88huang-zz deleted the config branch January 19, 2020 01:55
huangdx0726 pushed a commit to huangdx0726/pulsar that referenced this pull request Aug 24, 2020
### Motivation
Some parameters are added in the `broker.conf` and `standalone.conf` files. However, those parameters are not updated in the docs.
See the following PRs for details: apache#4150, apache#4066, apache#4197, apache#3819, apache#4261, apache#4273, apache#4320.

### Modifications
Add those parameter info, and sync docs with the code.

Does not update the description quite much, there are two reasons for this:
1. Keep doc content consistent with code. We need to update the description for those parameters in the code first, and then sync them in docs.
2. Will adopt a generator to generate those content automatically in the near future.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/config doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants