Skip to content

As a developer, I want to document HTTP URL knowledge files in nabledge-1.4 so that their known S11 warnings are understood #240

@kiyotis

Description

@kiyotis

Situation

4 nabledge-1.4 knowledge files reference HTTP (not HTTPS) URLs because the corresponding Nablarch 1.4 era source documents (from ~2014) contain HTTP links that predate the HTTPS migration of those external sites.

These files fail the S11 (URL not https) structure check:

File ID HTTP URL
libraries-02_basic http://www.oracle.com/technetwork/java/javamail/index.html
java-static-analysis-05_JavaStaticAnalysis http://findbugs.sourceforge.net/
biz-samples-0101_PBKDF2PasswordEncryptor--s1 http://www.ietf.org/rfc/rfc2898.txt
ui-framework-css_framework--s1 http://fortawesome.github.io/Font-Awesome/icons/

Pain

These 4 files will always fail the S11 structure check because their HTTP URLs are accurate representations of the source content — the original Nablarch 1.4 documentation used these HTTP links.

Benefit

  • The S11 failures for these 4 files are accepted as known issues rather than being silently ignored
  • Future developers understand why these files have S11 warnings

Success Criteria

  • These 4 files are documented as known exceptions in the nabledge-1.4 quality notes
  • Decision recorded: accept as-is (HTTP URLs are accurate to source content)

Notes

Decision: Accept as known issues. The URLs accurately represent the source documentation. Updating the URLs to HTTPS would require modifying the knowledge file content beyond what the source documents say, which is outside the knowledge creator's scope.

Possible future improvement: add a per-file S11 exception mechanism to the structure checker (similar to a linting ignore comment).

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions