Skip to content

Use runnable code to generate main documentation samples #6313

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
Closed
philwebb opened this issue Jul 4, 2016 · 4 comments
Closed

Use runnable code to generate main documentation samples #6313

philwebb opened this issue Jul 4, 2016 · 4 comments
Assignees
@philwebb
Labels
type: task A general task
Milestone
2.5.0

Comments

@philwebb
Copy link
Member

philwebb commented Jul 4, 2016

We should look at using running sample code imported into our .adoc files to prevent issues like #6312. Spring Security has done this already.
@philwebb philwebb added type: enhancement A general enhancement type: documentation A documentation update labels Jul 4, 2016
@snicoll
Copy link
Member

snicoll commented Jul 4, 2016

That and actually testing them would be nice to ensure backward compatibility.

@wilkinsona
Copy link
Member

I've done it in REST Docs too. It's not too arduous.

@wilkinsona
Copy link
Member

I've made a (tiny) start on this. See in ccaa19d.

@philwebb philwebb added this to the 2.x milestone Dec 14, 2018
@philwebb philwebb removed the type: enhancement A general enhancement label Dec 14, 2018
@wilkinsona wilkinsona mentioned this issue Aug 30, 2019
Closed
@snicoll snicoll mentioned this issue Oct 2, 2020
Closed
@philwebb philwebb added the for: team-meeting An issue we'd like to discuss as a team to make progress label Feb 2, 2021
@philwebb philwebb self-assigned this Feb 2, 2021
@philwebb philwebb mentioned this issue Feb 3, 2021
Closed
@philwebb philwebb added type: task A general task and removed type: documentation A documentation update labels Feb 3, 2021
@philwebb philwebb modified the milestones: 2.x, 2.5.x Feb 3, 2021
@philwebb philwebb removed the for: team-meeting An issue we'd like to discuss as a team to make progress label Feb 3, 2021
philwebb added a commit that referenced this issue Feb 4, 2021
@philwebb
Add pending-extract attribute to source
ae1be76 
Add `pending-extract=true` to source blocks to help us identify
those that need to be extracted to a real source file.

See gh-6313
philwebb added a commit that referenced this issue Feb 4, 2021
@philwebb
Add additional dependencies for example code
e0392c4 
Add additional dependencies useful for the example code.

See gh-6313
philwebb added a commit that referenced this issue Feb 4, 2021
@philwebb
Extract some code samples from docs
0e326d6 
See gh-6313
philwebb added a commit that referenced this issue Feb 5, 2021
@philwebb
Extract code samples from docs
23ebf01 
See gh-6313
philwebb added a commit that referenced this issue Mar 9, 2021
@philwebb
Use new backend features for extracted samples
05cf7fb 
Update extracted samples to make use of code folding and chomping.

See gh-6313
philwebb added a commit that referenced this issue Mar 13, 2021
@philwebb
Extract code samples from docs
bea307b 
See gh-6313
@philwebb philwebb mentioned this issue Apr 6, 2021
Closed
philwebb added a commit that referenced this issue Apr 24, 2021
@philwebb
Extract code samples from docs
02cc778 
See gh-6313
philwebb added a commit that referenced this issue Apr 24, 2021
@philwebb
Extract code samples from docs
f30d48e 
See gh-6313
philwebb added a commit that referenced this issue Apr 25, 2021
@philwebb
Extract code samples from docs
32a87fc 
See gh-6313
philwebb added a commit that referenced this issue Apr 26, 2021
@philwebb
Extract code samples from docs
5e8f383 
See gh-6313
philwebb added a commit that referenced this issue Apr 30, 2021
@philwebb
Align docs package structure with heading IDs
09e8580 
See gh-6313
philwebb added a commit that referenced this issue May 1, 2021
@philwebb
Polish docs code
b314d84 
See gh-6313
philwebb added a commit that referenced this issue May 4, 2021
@philwebb
Extract code samples from docs
9aad29d 
See gh-6313
philwebb added a commit that referenced this issue May 4, 2021
@philwebb
Polish doc code samples
b5583a4 
See gh-6313
@philwebb philwebb closed this as completed May 6, 2021
@philwebb philwebb modified the milestones: 2.5.x, 2.5.0 May 6, 2021
@philwebb philwebb changed the title Use runnable code to generate documentation samples Use runnable code to generate main documentation samples May 6, 2021
@philwebb
Copy link
Member Author

philwebb commented May 6, 2021

Marking this one as complete but we might need to do the same with Gradle/Maven docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@philwebb philwebb

Labels
type: task A general task
Projects
None yet
Milestone
2.5.0
Development

No branches or pull requests
3 participants
@snicoll @philwebb @wilkinsona