spring-projects / spring-projects/spring-security

Add a how to run the samples section to Samples chapter in docs

Open
#8,191 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

in: docs type: enhancement
Dominant language
Java
Stars
9.6k
Forks
6.3k
Avg merge
2d 11h
Merged PRs (30d)
52

Description

Chapter 7 Samples does not provide any guidance on how to run the samples. The samples have dependencies based on the gradle project for example

apply plugin: 'io.spring.convention.spring-sample-boot'

dependencies {
	compile project(':spring-security-config')
	compile project(':spring-security-web')
	compile 'org.springframework.boot:spring-boot-starter-thymeleaf'
	compile 'org.springframework.boot:spring-boot-starter-web'
	compile 'org.thymeleaf.extras:thymeleaf-extras-springsecurity5'

	testCompile project(':spring-security-test')
	testCompile 'org.springframework.boot:spring-boot-starter-test'
}

To run the samples you can't just import that one project into the IDE you need to import all of spring security project into the IDE. Also the link to the samples from the docs points to the master branch, the user might be on a different version of spring security and so the samples as shown in master might not be useful to the reader.

I propose adding a section to the docs on how to run the samples. The section should should cover.

  • software prereqs to run the sample (Java version), IDE ... etc
  • instructions on how to import and run the samples
  • instructions on how to contribute fixes and improvements to the samples to make them more useful to users.

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 with the Chapter 7 Samples documentation and inspect the sample Gradle project and its links to the master branch. Document Java and IDE prerequisites, importing the full Spring Security project, running a sample, and contributing sample fixes. Done means the Samples chapter explains these steps and directs readers to samples matching their Spring Security version.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring-boot
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.