[ELY-2343] Add a web option to the Elytron Tool#2198
[ELY-2343] Add a web option to the Elytron Tool#2198rsearls wants to merge 1 commit intowildfly-security:2.xfrom
Conversation
|
/retest |
|
Looking at the history of this PR I think we still have the issue of deciding the correct reference location for documentation. As an alternate to the options raised so far we could think about adding a guide to the repo itself using MD - that way with the correct syntax users could be pointed to the correct version of the guide and we could keep it up to date in the Elytron repo as we do for the rest of the source. |
|
Just to summarize discussions from the previous PR. The problems identified was that we should not tie Elytron project to the WildFly project and we should be able to link to proper version in use. There was an idea to point a user to the https://wildfly-security.github.io/wildfly-elytron/documentation/api/next/org/wildfly/security/tool/package-summary.html , this might require us to update JavaDoc to add more details, and make versions available as now I do not see links for older versions. @darranl 's idea above is to use markdown, which would also solve versioning for both EAP and WF as it is tied to codebase directly. As a trade off we would have to keep in mind to update this file as needed. I see no other disadvantages. It will continue working even if anything happens to the website, so I like this idea best. @rsearls @petrberan WDYT? |
|
agreed. Pointing to documentation within the project would be best. |
https://issues.redhat.com/browse/ELY-2343
This is a new up to date (rebased) version of PR
#1715