[FOLIO-264] Method to publish generated documentation from project repos Created: 24/Aug/16 Updated: 12/Nov/18 Resolved: 10/Nov/16 |
|
| Status: | Closed |
| Project: | FOLIO |
| Components: | None |
| Affects versions: | None |
| Fix versions: | None |
| Type: | Task | Priority: | P2 |
| Reporter: | John Malconian | Assignee: | John Malconian |
| Resolution: | Duplicate | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | 1 hour | ||
| Original estimate: | Not Specified | ||
| Sprint: |
| Description |
|
FOLIO modules and other projects will generate HTML-formatted documentation at build time. This documentation needs to be published in a publicly accessible location and updated after each build. The documentation should be linked to by the main FOLIO development web site. |
| Comments |
| Comment by John Malconian [ 24/Aug/16 ] |
|
Experimenting with utilizing a S3 web service as a repository for generated documentation. A build step would need to be added to each Jenkin's job that generates documentation to "publish" the docs to the S3 bucket. S3 contains no additional server-side CGI, so as long as that is not an requirement, then it looks to be a viable option. |
| Comment by John Malconian [ 24/Aug/16 ] |
|
Created an S3 bucket with the appropriate access-control policies available at http://foliodocs.s3-website-us-east-1.amazonaws.com |
| Comment by John Malconian [ 10/Nov/16 ] |
|
A new issue essentially duplicates this: DMOD-88. |