search

jakartaee / rest

Jakarta RESTful Web Services
Other
362 stars 117 forks source link

TCK Migration : Move the jaxrs TCK users guide and documentation #1040

Closed alwin-joseph closed 2 years ago

alwin-joseph commented 2 years ago

We need to move the docs and related contents from jakartaee-tck project to the new REST TCK. This issue is to track this migration. The task of updating the contents of assertions , release notes and users guide can be taken up post this migration.

  1. Documentation source : The tck documentation source folder (docs) would have below folder structure : 
|-- assertions
|   |-- JAXRSJavadocAssertions.html
|   `-- JAXRSSpecAssertions.html
|-- index.html
|-- JAXRSTCK3.0-ReleaseNotes.html
|-- ts.jtx ->  (test exclude list)
`-- userguide
    |-- pom.xml
    |-- README.md
    `-- src
        |-- main
        |   `-- jbake
        |       |-- assets/
        |       |-- content/
        |       |-- jbake.properties
        |       `-- templates

Here the userguide folder is a maven project that builds html & pdf users guide, when the tck is built.

Please suggest which is the right place for this docs folder to exist in this repository. I propose we add it to jaxrs-api/jaxrs-tck/ folder directly.

@spericas @jansupol @andymc12 @mkarg @edbratt

  1. Documentation in TCK bundle : The documentation can be made available in the final tck bundle(zip) as per below. Final TCK bundle : restful-ws-tck-3.1.0.zip. Upon extracting this zip bundle we would get jakarta.ws.rs-tck-3.1.0.jar(as it is built right now) and docs folder. The docs folder will have below folder structure in the tck bundle : 
|-- assertions
|   |-- JAXRSJavadocAssertions.html
|   `-- JAXRSSpecAssertions.html
|-- index.html
|-- JAXRSTCK3.0-ReleaseNotes.html
|-- ts.jtx
|-- index.html
|-- JAXRSTCK3.0-ReleaseNotes.html
|-- html-usersguide
|   |-- intro.html
|   |-- preface.html
|-- pdf-usersguide
|   `-- Jakarta-RESTful-Web-Services-TCK-Users-Guide.pdf

Thoughts ?