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

Adjust build-docs/action to make /docs dir if it doesn't exist #42

Merged
merged 8 commits into from
Jul 16, 2024

Conversation

aulorbe
Copy link
Contributor

@aulorbe aulorbe commented Jul 16, 2024

Problem

Since /docs doesn't exist, the GH action build-docs/action cannot run.

Solution

Change file to check if /docs exists first; if it doesn't, create it; if it does, move on.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Infrastructure change (CI configs, etc)
  • Non-code change (docs, etc)
  • None of the above: (explain here)

Test Plan

CI passes.

@aulorbe aulorbe requested a review from austin-denoble July 16, 2024 23:49
@aulorbe aulorbe merged commit 454cfbf into main Jul 16, 2024
3 checks passed
@aulorbe aulorbe deleted the Audrey/make-docs-dir branch July 16, 2024 23:53
aulorbe added a commit that referenced this pull request Jul 17, 2024
## Problem

We tried a variety of different solutions for pushing static
documentation to our GH pages site (see `sdk-docs` repo for more
information), but the rendering was very bad.

Related PRs: 
- #41
- #42
- #43
- #44
- #45
- #46

## Solution

- Simply use the default hosting site of pkg.go.dev, and include
instructions for visiting the documentation on `main` vs the latest
release-version's documentation.
- Changed the documentation badge to point to latest documentation on
`main` instead of latest versioned-release's documentation.
- Remove GH workflow and action files

## Type of Change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [x] This change requires a documentation update
- [ ] Infrastructure change (CI configs, etc)
- [ ] Non-code change (docs, etc)
- [ ] None of the above: (explain here)
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.

2 participants