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

scripts to publish javadoc and doc to cloud-rad #1317

Merged
merged 9 commits into from
Nov 10, 2022
Merged

Conversation

zhumin8
Copy link
Contributor

@zhumin8 zhumin8 commented Nov 3, 2022

Adding kokoro scripts and related changes needed to assemble and upload to be published javadoc and documentation to cloud-rad process. Intend to get this in for some final test run before:

  • changing from dev to prod bucket
  • removing debug info from script.

Also in this pr: table format changes in getting-started.md and pubsub.md to fix rendered html format issues.

update: switch to use a requirements.txt file with hash checking to securely install dependencies with pip install.

@zhumin8
Copy link
Contributor Author

zhumin8 commented Nov 9, 2022

force-pushed after rebase.

@zhumin8 zhumin8 marked this pull request as ready for review November 9, 2022 16:25
@zhumin8 zhumin8 requested review from elefeint and mpeddada1 November 9, 2022 16:26
Comment on lines 25 to 28
python3 -m pip install --upgrade six
python3 -m pip install --upgrade protobuf
python3 -m pip install gcp-docuploader==0.6.2

Copy link
Contributor

Choose a reason for hiding this comment

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

The public_javadoc scripts in googleapis/ were recently migrated to use a requirements.txt file with hash checking to securely install dependencies. Maybe we could do the same here? Here's an example: googleapis/synthtool#1588

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated with changes. Test run succeeded.
image

Copy link
Contributor

Choose a reason for hiding this comment

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

Nice!

@sonarqubecloud
Copy link

sonarqubecloud bot commented Nov 9, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@zhumin8 zhumin8 requested review from mpeddada1 and elefeint November 9, 2022 20:53
@zhumin8 zhumin8 merged commit 9474c12 into main Nov 10, 2022
@zhumin8 zhumin8 deleted the docfx-test-3.5 branch November 10, 2022 14:48
zhumin8 added a commit that referenced this pull request Jul 7, 2023
As discussed offline, removing markdown documentation and related files that preps to publish them.
These markdown style documentation and scripts introduced in #1317 were to publish documentation but is not published yet. The markdown style documentations were created and kept in parallel to asciidoc ones and creates toil when updates needed for docs.
This pr removes them and kept snapshot before removal in [branch](https://github.com/GoogleCloudPlatform/spring-cloud-gcp/tree/md-docs).

removed: 
- md docs
- scripts to upload them
- `docfx` profile from `pom.xml`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants