You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We currently generate documentation as a single unit holistic doc site. We need to extend this capability to generate doc sites at the per package level.
Eventually, our unified pipelines will publish these artifacts to a blob storage static web hosting container, but first we need to generate them.
Expected output at the end of this:
An additional DevOps build artifact that includes a static site for each package generated in the current CI.
For the generated html, the readme of the source package should be the landing page.
Any "relative links" within the readme should be updated so that they function properly when rendered on github.io
The methodology driving this will be unique per language, and I leave it up to the implementor how we make it happen.
Example
Java core CI should contain a doc site for each of the following packages:
azure-core
azure-core-amqp
azure-core-http-netty
azure-core-http-okhttp
azure-core-management
azure-core-test
The text was updated successfully, but these errors were encountered:
scbedd
changed the title
Generate Individual Package Documentation in CI Builds - Java
Generate Individual Package Documentation in CI Builds - JS
Sep 19, 2019
scbedd
changed the title
Generate Individual Package Documentation in CI Builds - JS
Generate Individual Package Documentation in CI Builds - Java
Sep 19, 2019
I'm going to close this out. Work was done to add the readme to the landing page and update the doc index. The PRs for those were #6006 #6144
There were other tooling changes submitted by others in other PRs (some work was a combined effort that spanned all 4 languages, not just Java).
Intent and Context
We currently generate documentation as a single unit holistic
doc site
. We need to extend this capability to generate doc sites at the per package level.Eventually, our unified pipelines will publish these artifacts to a blob storage static web hosting container, but first we need to generate them.
Expected output at the end of this:
build artifact
that includes a static site for each package generated in the current CI.github.io
The methodology driving this will be unique per language, and I leave it up to the implementor how we make it happen.
Example
Java core CI should contain a doc site for each of the following packages:
azure-core
azure-core-amqp
azure-core-http-netty
azure-core-http-okhttp
azure-core-management
azure-core-test
The text was updated successfully, but these errors were encountered: