spring-projects / spring-projects/spring-boot

Use code-include for Gradle Groovy/Kotlin in documention

Open
#40,070 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

type: task
Dominant language
Java
Stars
81.5k
Forks
42.7k
Avg merge
2d 4h
Merged PRs (30d)
65

Description

There's a lot of copy/paste at the moment, especially with the tabs markup. We could use something like code-include if it could be configured differently.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the duplicated Gradle Groovy and Kotlin documentation and reviewing how its tabs markup is currently maintained. Investigate whether code-include can be configured differently for these examples; done means the repeated copy/paste and tabs markup are replaced without losing the documented examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
groovy, kotlin
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.