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.

Sign up for GitHub

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

Jump to bottom

Provide code samples in Kotlin in addition to Java [SPR-17245] #21778

Closed
spring-projects-issues opened this issue Sep 5, 2018 · 3 comments
Closed

Provide code samples in Kotlin in addition to Java [SPR-17245] #21778

spring-projects-issues opened this issue Sep 5, 2018 · 3 comments
Assignees
@sdeleuze
Labels
type: documentation A documentation task
Milestone
5.2 RC2

Comments

@spring-projects-issues
Copy link
Collaborator

Sébastien Deleuze opened SPR-17245 and commented

Even if we have a dedicated Kotlin section in our reference documentation, all the code samples are in Java, requiring an effort for Kotlin users to translate it. I would like to make our documentation more natively Kotlin friendly by translating our code example to Kotlin.

This could be done via a Kotlin tab (in addition to the Java one) on each code sample block, and by generating 2 versions of the documentation: one in Java, one in Kotlin.

1 votes, 3 watchers
@spring-projects-issues
Copy link
Collaborator Author

Sébastien Deleuze commented

Gradle team shared what they use on their documentation to have nice looking Groovy + Kotlin code snippets + cookie based remembering of the chosen language. I think it could be a good fit for us, it would be also nice to be able to link a specific language like we do on start.spring.io.

@spring-projects-issues
Copy link
Collaborator Author

Sébastien Deleuze commented

There is now also a dedicated blog post.

@spring-projects-issues spring-projects-issues added the type: documentation A documentation task label Jan 11, 2019
@spring-projects-issues spring-projects-issues added this to the 5.2 RC1 milestone Jan 11, 2019
@jhoeller jhoeller modified the milestones: 5.2 M1, 5.2 RC1 Mar 23, 2019
@sdeleuze sdeleuze modified the milestones: 5.2 M3, 5.2 RC1 Jun 7, 2019
@sdeleuze sdeleuze modified the milestones: 5.2 RC1, 5.2 GA Jul 8, 2019
@sdeleuze sdeleuze modified the milestones: 5.2 GA, 5.2 RC2 Aug 12, 2019
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Aug 12, 2019
@sdeleuze
Add Kotlin code snippets to core refdoc
9665823 
This commit introduces Kotlin code snippets, for now
in the core reference documentation. Other sections
will follow, as well as improvements like global
language switch.

See spring-projectsgh-21778
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Aug 12, 2019
@sdeleuze
Add missing css file
f3c7879 
See spring-projectsgh-21778
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Aug 13, 2019
@sdeleuze
Remove the black border from code samples
a2b8ea5 
See spring-projectsgh-21778
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Aug 13, 2019
@sdeleuze
Add global language switch capabilities to the refdoc
eff9cae 
See spring-projectsgh-21778
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Aug 14, 2019
@sdeleuze
Store refdoc preferred language
ec74055 
See spring-projectsgh-21778
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Aug 14, 2019
@sdeleuze
Restore annotated code samples
db02d38 
See spring-projectsgh-21778
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Aug 14, 2019
@sdeleuze
Polishing
7664564 
See spring-projectsgh-21778
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Aug 22, 2019
@sdeleuze
Add Kotlin code snippets to WebMvc refdoc
0d3fb0e 
See spring-projectsgh-21778
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Aug 28, 2019
@sdeleuze
Add Kotlin code snippets to WebFlux refdoc
1455884 
See spring-projectsgh-21778
@kohlmu-pivotal kohlmu-pivotal mentioned this issue Aug 30, 2019
Closed
kohlmu-pivotal pushed a commit to kohlmu-pivotal/spring-framework that referenced this issue Aug 30, 2019
Adding Kotlin code examples to Testing documentation.
83470f9 
See - spring-projectsgh-21778
kohlmu-pivotal pushed a commit to kohlmu-pivotal/spring-framework that referenced this issue Aug 30, 2019
Reverting public modifiers.
5216a0d 
Adding code callouts for both Java and Kotlin

See - spring-projectsgh-21778
sdeleuze pushed a commit to sdeleuze/spring-framework that referenced this issue Aug 31, 2019
@sdeleuze
Add Kotlin code snippets to testing refdoc
b20a8c9 
See spring-projectsgh-21778
@sdeleuze
Copy link
Contributor

All major parts of the reference documentation now have Kotlin code samples: Core, Testing, WebFlux and WebMvc. Other places will be completed later.

sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Sep 3, 2019
@sdeleuze
Add Kotlin code snippets to data access refdoc
f8516c6 
See spring-projectsgh-21778
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sdeleuze sdeleuze

Labels
type: documentation A documentation task
Projects
None yet
Milestone
5.2 RC2
Development

No branches or pull requests
3 participants
@sdeleuze @jhoeller @spring-projects-issues