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 note view cloud docs page #4491

Closed
1 task done
ezerkar opened this issue Nov 16, 2023 · 0 comments · Fixed by #4508
Closed
1 task done

add note view cloud docs page #4491

ezerkar opened this issue Nov 16, 2023 · 0 comments · Fixed by #4508
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear

Comments

@ezerkar
Copy link

ezerkar commented Nov 16, 2023

Contributions

  • I have read the contribution docs, and understand what's expected of me.

Link to the page on docs.getdbt.com requiring updates

https://docs.getdbt.com/docs/collaborate/build-and-view-your-docs

What part(s) of the page would you like to see updated?

Took me a lot of time to understand why I the docs are not updating until I understood that the fact that some of my tests are failing made the whole run to be not considered for docs update. This actually makes sense (controversial but still) but think should be explicitly mentioned in docs:

expected outcome:

Viewing documentation

Once you set up a job to generate documentation for your project, you can click Documentation in the top left. Your project's documentation should open. This link will always navigate you to the most recent version of your project's documentation in dbt Cloud.
Do note that only the generated docs of last fully successful run will appear here, so if any task has failed (including tests) changes done to the docs by this run would not be reflected (if there was never a fully successful run no documents will show).

Additional information

No response

@ezerkar ezerkar added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear labels Nov 16, 2023
bbrewington pushed a commit to bbrewington/fork--docs.getdbt.com that referenced this issue Nov 22, 2023
Closes dbt-labs#4491

## What are you changing in this pull request and why?

Makign a change to outline that you need successful runs to have docs
updated.

## Checklist
<!--
Uncomment if you're publishing docs for a prerelease version of dbt
(delete if not applicable):
- [ ] Add versioning components, as described in [Versioning
Docs](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-entire-pages)
- [ ] Add a note to the prerelease version [Migration
Guide](https://github.com/dbt-labs/docs.getdbt.com/tree/current/website/docs/docs/dbt-versions/core-upgrade)
-->
- [ ] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.
- [ ] For [docs
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#about-versioning),
review how to [version a whole
page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
and [version a block of
content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content).
- [ ] Add a checklist item for anything that needs to happen before this
PR is merged, such as "needs technical review" or "change base branch."

Adding new pages (delete if not applicable):
- [ ] Add page to `website/sidebars.js`
- [ ] Provide a unique filename for the new page

Removing or renaming existing pages (delete if not applicable):
- [ ] Remove page from `website/sidebars.js`
- [ ] Add an entry `website/static/_redirects`
- [ ] Run link testing locally with `npm run build` to update the links
that point to the deleted page

---------

Co-authored-by: mirnawong1 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant