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

Add generated docs for sdc-0.1.0-beta03, engine-0.1.0-beta01, workflow-0.1.0-alpha01 #1467

Merged
merged 5 commits into from
Jul 21, 2022

Conversation

williamito
Copy link
Contributor

@williamito williamito commented Jun 21, 2022

IMPORTANT: All PRs must be linked to an issue (except for extremely trivial and straightforward changes).

Fixes #1457

Description
Generated reference docs for each library's latest released version by doing e.g. git checkout tags/sdc-0.1.0-beta03 -b sdc-0.1.0-beta03 and running a gradle task similar to PR #1466 .

Alternative(s) considered
Placing docs into a version-named directory

  • Pros: Previous docs versions easily available
  • Cons: More difficult to see diff between versions at release

Type
Documentation

Checklist

  • I have read and acknowledged the Code of conduct.
  • I have read the Contributing page.
  • I have signed the Google Individual CLA, or I am covered by my company's Corporate CLA.
  • I have discussed my proposed solution with code owners in the linked issue(s) and we have agreed upon the general approach.
  • I have run ./gradlew spotlessApply and ./gradlew spotlessCheck to check my code follows the style guide of this project.
  • I have run ./gradlew check and ./gradlew connectedCheck to test my changes locally.
  • I have built and run the demo app(s) to verify my change fixes the issue and/or does not break the demo app(s).

@codecov
Copy link

codecov bot commented Jun 21, 2022

Codecov Report

Merging #1467 (501a30e) into master (86779ee) will increase coverage by 89.74%.
The diff coverage is n/a.

❗ Current head 501a30e differs from pull request most recent head 2708398. Consider uploading reports for the commit 2708398 to get more accurate results

@@              Coverage Diff              @@
##             master    #1467       +/-   ##
=============================================
+ Coverage          0   89.74%   +89.74%     
- Complexity        0      646      +646     
=============================================
  Files             0      129      +129     
  Lines             0     9879     +9879     
  Branches          0      742      +742     
=============================================
+ Hits              0     8866     +8866     
- Misses            0      622      +622     
- Partials          0      391      +391     
Impacted Files Coverage Δ
...d/fhir/search/filter/NumberParamFilterCriterion.kt 100.00% <0.00%> (ø)
...d/fhir/datacapture/utilities/MoreLocalDateTimes.kt 100.00% <0.00%> (ø)
...oogle/android/fhir/sync/download/DownloaderImpl.kt 100.00% <0.00%> (ø)
...n/java/com/google/android/fhir/sync/SyncJobImpl.kt 62.16% <0.00%> (ø)
...a/com/google/android/fhir/sync/FhirSynchronizer.kt 79.31% <0.00%> (ø)
...ava/com/google/android/fhir/impl/FhirEngineImpl.kt 40.81% <0.00%> (ø)
...n/java/com/google/android/fhir/search/SearchDsl.kt 90.66% <0.00%> (ø)
...ws/QuestionnaireItemRadioGroupViewHolderFactory.kt 77.02% <0.00%> (ø)
...main/java/com/google/android/fhir/DatastoreUtil.kt 80.00% <0.00%> (ø)
...fhir/search/filter/QuantityParamFilterCriterion.kt 100.00% <0.00%> (ø)
... and 119 more

@jingtang10
Copy link
Collaborator

Can you please document the gradle task to run to generate the docs?

Copy link
Collaborator

@jingtang10 jingtang10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why are some of the file names and directory names include so many hypens "-"?

@Tarun-Bhardwaj Tarun-Bhardwaj added the P2 Medium priority issue label Jul 12, 2022
@williamito
Copy link
Contributor Author

Catching back up after vacation.

@jingtang10

  1. How would you like the gradle tasks documented?
  2. The hyphens are because Java/Kotlin are case-sensitive, and the doc generator converts uppercase characters to -[lower], e.g. A becomes -a. If the thing is in all caps, it turns into a gross filename. I believe the rendered version is fine though. See Make uppercase-to-lowercase file name conversion configurable Kotlin/dokka#2229

@williamito williamito enabled auto-merge (squash) July 18, 2022 11:47
@jingtang10
Copy link
Collaborator

Catching back up after vacation.

@jingtang10

  1. How would you like the gradle tasks documented?

When do they need to be run? Each time we make a release? In that case should be documented in our release process.

  1. The hyphens are because Java/Kotlin are case-sensitive, and the doc generator converts uppercase characters to -[lower], e.g. A becomes -a. If the thing is in all caps, it turns into a gross filename. I believe the rendered version is fine though. See Make uppercase-to-lowercase file name conversion configurable Kotlin/dokka#2229

ah ok if this is just a dokka thing and we can't control it's fine.

@jingtang10
Copy link
Collaborator

how can we preview this docs?

@williamito williamito disabled auto-merge July 20, 2022 16:53
@williamito
Copy link
Contributor Author

When do they need to be run? Each time we make a release? In that case should be documented in our release process.

Correct - I will update the release documentation with instructions after #1466 is merged. I'll also need to regenerate the data capture docs to reflect the values in Releases.kt (datacapture vs data-capture)

Copy link
Collaborator

@jingtang10 jingtang10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like /docs/engine/html/engine is a duplicate of /docs/engine/engine?

sdc and workflow don't have the html/ subdiretory.

@williamito williamito requested a review from joiskash as a code owner July 21, 2022 04:18
@williamito
Copy link
Contributor Author

Looks like /docs/engine/html/engine is a duplicate of /docs/engine/engine?

sdc and workflow don't have the html/ subdiretory.

Fixed, I must have messed up copying docs around to generate at 3 different tags.

@jingtang10 jingtang10 enabled auto-merge (squash) July 21, 2022 08:38
Copy link
Collaborator

@jingtang10 jingtang10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for this

@jingtang10 jingtang10 merged commit 458a05f into google:master Jul 21, 2022
@Tarun-Bhardwaj Tarun-Bhardwaj added the type:documentation Improvements or additions to documentation label Jul 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P2 Medium priority issue type:documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Integrate Dokka into all SDK components and build API reference docs
3 participants