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

Remove GH workflow and actions to generate documentation #47

Merged
merged 1 commit into from
Jul 17, 2024

Conversation

aulorbe
Copy link
Contributor

@aulorbe aulorbe commented 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:

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)
  • This change requires a documentation update
  • Infrastructure change (CI configs, etc)
  • Non-code change (docs, etc)
  • None of the above: (explain here)

@aulorbe aulorbe requested a review from austin-denoble July 17, 2024 19:02
@@ -10,7 +10,7 @@ jobs:
steps:
- uses: actions/checkout@v4
- name: Setup Go
uses: actions/setup-go@v4
uses: actions/setup-go@v5
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just updated this while I was in there -- it's the latest action

## Documentation
To see the latest documentation on `main`, visit https://pkg.go.dev/github.com/pinecone-io/go-pinecone@main/pinecone.

To see the latest versioned-release's documentation, visit https://pkg.go.dev/github.com/pinecone-io/go-pinecone/pinecone.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This auto-resolves to the latest release

@@ -5,10 +5,15 @@

# go-pinecone

[![Go Reference](https://pkg.go.dev/badge/github.com/pinecone-io/go-pinecone.svg)](https://pkg.go.dev/github.com/pinecone-io/go-pinecone)
[![Go Reference](https://pkg.go.dev/badge/github.com/pinecone-io/go-pinecone.svg)](https://pkg.go.dev/github.com/pinecone-io/go-pinecone@main/pinecone)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@main here points at the main branch

Copy link
Contributor

@austin-denoble austin-denoble left a comment

Choose a reason for hiding this comment

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

Really appreciate the diligence here, thank you Audrey!

@aulorbe aulorbe merged commit e1006f3 into main Jul 17, 2024
3 checks passed
@aulorbe aulorbe deleted the Audrey/remove-gh-workflow-for-documentation branch July 17, 2024 19:05
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