spring-cloud / spring-cloud/spring-cloud-consul
spring.cloud.consul.config.prefixes documentation update
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 822
- Forks
- 539
- Avg merge
- 9h 31m
- Merged PRs (30d)
- 7
Description
The documentation for spring-cloud-consul has no mention of the deprecation of spring.cloud.consul.config.prefix in favor of spring.cloud.consul.config.prefixes. I had to do dig up the code to see if the new (plural) property is a YAML list or if it is a comma separated String. The documentation at the below URL should be updated with an explanation.
https://docs.spring.io/spring-cloud-consul/docs/current/reference/html/#customizing
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked Spring Cloud Consul customizing documentation section and inspect the existing configuration-property descriptions. Confirm how spring.cloud.consul.config.prefixes is represented, then document the deprecation of the singular prefix property, the replacement property, and its accepted value format so the section is complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 78/100