Git Product home page Git Product logo

Comments (5)

dsyer avatar dsyer commented on June 4, 2024

I guess we need to look at all the configuration options

from spring-cloud-sleuth.

marcingrzejszczak avatar marcingrzejszczak commented on June 4, 2024

@dsyer - good idea, in micro-infra-spring we had a problem with actually finding all the options. Maybe we could think of automating that a little bit? I'm not saying that we should do it right now. It could be worth to generate a page with all the configuration options and maybe as a description pass the javadoc or sth. Just an idea...

Until then maybe it would be worth to create manually a table with current params, their defaults and some short description?

from spring-cloud-sleuth.

dsyer avatar dsyer commented on June 4, 2024

@snicoll has some tools to automate configuration docs. We should invest some time in them and get an appendix into Spring Cloud docs.

from spring-cloud-sleuth.

snicoll avatar snicoll commented on June 4, 2024

There are a few things here in particular AppendixGenerator

It's very raw but does the job for the checks I am applying between each release. Spring Boot does not generate the doc automatically yet but looking at this is good enough to spot inconsistencies (wrong/conflicting namespaces, etc).

Please ping me if you need more info

from spring-cloud-sleuth.

marcingrzejszczak avatar marcingrzejszczak commented on June 4, 2024

Done in http://cloud.spring.io/spring-cloud-static/spring-cloud.html

from spring-cloud-sleuth.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.