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

chore: Add preview and stable categories to resources and data sources in docs #3370

Merged
merged 3 commits into from
Feb 3, 2025

Conversation

sfc-gh-jmichalak
Copy link
Collaborator

@sfc-gh-jmichalak sfc-gh-jmichalak commented Jan 31, 2025

  • Group stable and preview resources and data sources in docs.
  • Adjust a few descriptions regarding preview status.

Test Plan

  • acceptance tests

References

Copy link

Integration tests cancelled for 53e8a876ad16ec0d76aac48d19a71d9f958a4936

Copy link
Collaborator

@sfc-gh-asawicki sfc-gh-asawicki left a comment

Choose a reason for hiding this comment

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

Additional two general comments:

  1. Let's add in the migration guide that we change the structure (add links there).
  2. I am a bit worried about the existing relative links:
  • between stable and preview (and the other way around) - because adding hierarchy probably changes them (we can check it in other providers using subcategories)
  • between resource/data source and guide (and the other way around) - because again, they will be one level deeper

docs/resources/execute.md Show resolved Hide resolved
docs/resources/grant_ownership.md Show resolved Hide resolved
Copy link
Collaborator

@sfc-gh-jcieslak sfc-gh-jcieslak left a comment

Choose a reason for hiding this comment

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

Approved, but as Artur mentioned there may be issues with relative links.

@sfc-gh-asawicki sfc-gh-asawicki self-requested a review February 3, 2025 14:13
@sfc-gh-jmichalak
Copy link
Collaborator Author

I added a migration guide entry. I checked several providers, and the categories do not change link addresses.

@sfc-gh-jmichalak sfc-gh-jmichalak merged commit b061434 into dev Feb 3, 2025
8 of 9 checks passed
@sfc-gh-jmichalak sfc-gh-jmichalak deleted the docs-structure branch February 3, 2025 15:21
sfc-gh-jcieslak pushed a commit that referenced this pull request Feb 5, 2025
🤖 I have created a release *beep* *boop*
---


##
[1.0.3](v1.0.2...v1.0.3)
(2025-02-05)


### 🔧 **Misc**

* Add basic performance tests
([#3349](#3349))
([c57346b](c57346b))
* Add notes about managing grants on hybrid table
([#3368](#3368))
([e5e98bd](e5e98bd))
* Add preview and stable categories to resources and data sources in
docs
([#3370](#3370))
([b061434](b061434))
* Fix docs and update the protected users list
([#3365](#3365))
([f23e8cb](f23e8cb))
* Grant ownership common use cases
([#3356](#3356))
([97813b6](97813b6))
* Metric level fix with object renaming guide
([#3376](#3376))
([629ff92](629ff92))
* Move technical guides to the guide directory
([#3371](#3371))
([2b95809](2b95809))
* Prepare authentication methods guide
([#3364](#3364))
([c4a1c5f](c4a1c5f))
* Publish Performance tests summary
([#3359](#3359))
([d30d002](d30d002))
* Resolve issues and document account resource
([#3360](#3360))
([46b7a9d](46b7a9d))
* Upgrade tfplugindocs
([#3361](#3361))
([89f2b0a](89f2b0a))


### 🐛 **Bug fixes:**

* change EnforceNetworkRulesForInternalStages ddl to parameter
([#3343](#3343))
([beb01c7](beb01c7))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: snowflake-release-please[bot] <105954990+snowflake-release-please[bot]@users.noreply.github.com>
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