Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Trivial Trivial
    • Resolution: Complete
    • Affects Version/s: None
    • Fix Version/s: 3.1.0.M1
    • Component/s: Docs and Website
    • Labels:
      None

      Description

      I have a number of minor suggestions on how to improve the documentation. Some are bugs, but most are simply suggestions. They are all quite simple so I am only logging as one JIRA, but if preferred I can (or the assignee) can add additional JIRAs. I have only gone through 3.1.x, but some issues may pertain to 3.0.x as well. I can (if desired) look through 3.0.x as well.

      ---------------

      http://static.springsource.org/spring-security/site/build.html

      • It might be nice to update the build to mention using gradle. I noticed that bamboo appears to be using gradle. Knowing build should be done with gradle would be useful to know for anyone wanting to commit changes to use gradle to ensure all the tests are ran. I say this because it appears that the maven build does not run groovy tests (alternatively perhaps fix the maven build). I also believe I saw rumors of moving away from using maven directly (generating poms)...could be wrong on that though.
      • It would be nice to explain how to build Spring Security in an IDE.

      http://static.springsource.org/spring-security/site/docs/3.1.x/reference/introduction.html

      • The "integration page" link points to acegi security page (this is a bit dated)
      • "Spring Security fully supports automatic "channel security", together with JCaptcha integration for human user detection." Is JCaptcha integration still supported? From what I remember JCaptcha integration was removed due to lack of support by the original contributor (could be wrong though). Perhaps I am just misunderstanding what this is saying.
      • "You can checkout specific versions from https://src.springframework.org/svn/spring-security/tags/" The url is for svn but there is no example svn command. This could be changed to include a svn example or changing the url to a git url.

      http://static.springsource.org/spring-security/site/docs/3.1.x/reference/ns-config.html

      • update spring-security schemaLocation to be 3.1 (Not sure if this is required, but there is a 3.1 in git)
      • The documentation states "attribute on global-method-security to the Id". I think changing it to a lowercase id makes it easier to read as the uppercase can be confused to be an L. Additionally, lowercase matches the case of the xml attribute.

      http://static.springsource.org/spring-security/site/docs/3.1.x/reference/sample-apps.html

      • This page has another reference on how to build the project using maven. Perhaps talk about building with gradle?
      • Change spring-security-samples-contacts-3.0.x.war to spring-security-samples-contacts-3.1.x.war (the tutorial version is updated but contacts is not)

      http://static.springsource.org/spring-security/site/docs/3.1.x/reference/core-web-filters.html

      • The phrase "What happens if a user is already authenticated an they" should change 'an' to 'and'
      • The phrase "A typical example would be where the user logs in with a from," should change 'from' to 'form'

      http://static.springsource.org/spring-security/site/docs/3.1.x/reference/remember-me.html

      • The phrase "correct GrantedAuthority[]s." contains invalid character after GrantedAuthority

      http://static.springsource.org/spring-security/site/docs/3.1.x/reference/authz-arch.html

      • There are two links with text "technical overview" and "Technical Overview" ...the case is inconsistent. Most the reset of the links are lower case.

      http://static.springsource.org/spring-security/site/docs/3.1.x/reference/jaas.html

      • The phrase "single principal, and multiple GrantedAuthority[]s." contains invalid character after GrantedAuthority

      http://static.springsource.org/spring-security/site/docs/3.1.x/reference/appendix-namespace.html

      • The link "schema file" is a broken (404)
      • /spring-security-login should be /spring_security_login (2 places to replace)
      • remember-me / token-repository-ref is listed twice
      • remember-me services-ref should document it needs to implement LogoutHandler too. Updates to the documentation for remember-me-services-ref in the .rnc should be made also. See http://forum.springsource.org/showthread.php?t=91795.
      • remember-me services-ref "Id of a bean" might read better as "id of a bean"
      • user-services-ref "bean Id explicitly" might read better as "bean id explicitly"
      • "Again, this can be specified by Id" might read better with lowercase id
      • "This is actually the bean Id" might read better with lowercase id

        Activity

        Hide
        Luke Taylor added a comment - - edited

        Thanks Rob. I've updated the docs based on your suggestions. Gradle was only set up on bamboo a few days ago and maven should still work for building the project. I'll update the website if/when the switch takes place officially .

        Thanks for your help answering questions in the forum, btw.

        Show
        Luke Taylor added a comment - - edited Thanks Rob. I've updated the docs based on your suggestions. Gradle was only set up on bamboo a few days ago and maven should still work for building the project. I'll update the website if/when the switch takes place officially . Thanks for your help answering questions in the forum, btw.

          People

          • Assignee:
            Luke Taylor
            Reporter:
            Rob Winch
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: