Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate Individual Package Documentation in CI Builds - Java #5423

Closed
scbedd opened this issue Sep 19, 2019 · 1 comment
Closed

Generate Individual Package Documentation in CI Builds - Java #5423

scbedd opened this issue Sep 19, 2019 · 1 comment
Assignees
Labels
EngSys This issue is impacting the engineering system.

Comments

@scbedd
Copy link
Member

scbedd commented Sep 19, 2019

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:

  1. An additional DevOps build artifact that includes a static site for each package generated in the current CI.
  2. For the generated html, the readme of the source package should be the landing page.
  3. 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
@scbedd scbedd added the EngSys This issue is impacting the engineering system. label Sep 19, 2019
@scbedd scbedd changed the title Generate Individual Package Documentation in CI Builds - Java Generate Individual Package Documentation in CI Builds - JS Sep 19, 2019
@scbedd scbedd changed the title Generate Individual Package Documentation in CI Builds - JS Generate Individual Package Documentation in CI Builds - Java Sep 19, 2019
@JimSuplizio JimSuplizio self-assigned this Oct 9, 2019
@JimSuplizio
Copy link
Member

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).

@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
EngSys This issue is impacting the engineering system.
Projects
None yet
Development

No branches or pull requests

2 participants