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

Improve discoverability of starter documentation by adding a dedicate Boot Starter section in the reference #598

Closed
gmuth opened this issue Jan 13, 2023 · 2 comments
Assignees
Labels
type: documentation A documentation task
Milestone

Comments

@gmuth
Copy link

gmuth commented Jan 13, 2023

spring.graphql options and it's default values need to be looked up in class org.springframework.boot.autoconfigure.graphql.GraphQlProperties.

It would be great to have the meaning and default values documented in the reference documentation.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jan 13, 2023
@bclozel bclozel self-assigned this Jan 13, 2023
@bclozel bclozel added status: invalid An issue that we don't feel is valid for: external-project Needs a change in external project and removed status: waiting-for-triage An issue we've not yet triaged labels Jan 13, 2023
@bclozel
Copy link
Member

bclozel commented Jan 13, 2023

The properties class is part of Spring Boot, and it's documented automatically like all configuration properties. If your IDE supports it, you'll also get auto-completion when editing your application.yml file.

@bclozel bclozel closed this as not planned Won't fix, can't repro, duplicate, stale Jan 13, 2023
rstoyanchev added a commit that referenced this issue Jan 13, 2023
@rstoyanchev
Copy link
Contributor

rstoyanchev commented Jan 13, 2023

I've added a small "Boot Starter" section to our reference with a short summary. It includes links to all GraphQL related sections in the Boot reference, which are otherwise not listed anywhere in one place. This should make it easier to find the relevant information. It also gives us a local section to refer to whenever the Boot Starter is mentioned in our reference.

@rstoyanchev rstoyanchev reopened this Jan 13, 2023
@rstoyanchev rstoyanchev added type: documentation A documentation task and removed status: invalid An issue that we don't feel is valid for: external-project Needs a change in external project labels Jan 13, 2023
@rstoyanchev rstoyanchev assigned rstoyanchev and unassigned bclozel Jan 13, 2023
@rstoyanchev rstoyanchev added this to the 1.1.2 milestone Jan 13, 2023
@rstoyanchev rstoyanchev changed the title Document spring.graphql properties Improve discoverability of starter documentation by adding a dedicate Boot Starter section Jan 13, 2023
@rstoyanchev rstoyanchev changed the title Improve discoverability of starter documentation by adding a dedicate Boot Starter section Improve discoverability of starter documentation by adding a dedicate Boot Starter section in the reference Jan 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation task
Projects
None yet
Development

No branches or pull requests

4 participants