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

[Docs] Remove dashboard related content before code release #621

Closed
wants to merge 3 commits into from

Conversation

lingyielia
Copy link
Contributor

@lingyielia lingyielia commented Aug 7, 2024

Description

  • removed all dashboard related content
  • it's still visible in the API reference though, as the code is in main

Screenshot

Notice

  • I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

    • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
    • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorized to submit this contribution on behalf of the original creator(s) or their licensees.
    • I certify that the use of this contribution as authorized by the Apache 2.0 license does not violate the intellectual property rights of anyone else.
    • I have not referenced individuals, products or companies in any commits, directly or indirectly.
    • I have not added data or restricted code in any commits, directly or indirectly.

@github-actions github-actions bot added the Vizro-AI 🤖 Issue/PR that addresses Vizro-AI package label Aug 7, 2024
@lingyielia lingyielia self-assigned this Aug 7, 2024
Copy link
Contributor

@maxschulz-COL maxschulz-COL left a comment

Choose a reason for hiding this comment

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

As per our chat

@stichbury
Copy link
Contributor

Noted on Slack, but I think we should avoid rolling back these changes as there was quite a bit of re-org and rewording in the docs and not just the addition of these two files. I have an outstanding task to also clean up the structure of the Vizro-AI docs and I fear it could all get a bit complex (my poor 🧠 won't handle it).

Could we instead focus on making sure the links readers follow are typically going to the latest "stable" (ie released) docs as we intended. The way to do this:

  1. search and replace https://vizro.readthedocs.io/projects/vizro-ai/en/latest/ for https://vizro.readthedocs.io/projects/vizro-ai/ so that users get the versioned/"stable" docs
  2. search and replace https://vizro-ai.readthedocs.io/ for https://vizro.readthedocs.io/projects/vizro-ai/
  3. Find any external links to Vizro-AI docs (e.g. links in README files rather than in built docs, links in blog posts, release notes, even on Slack) and fix them as per 1/2
  4. TEST!

@maxschulz-COL
Copy link
Contributor

Noted on Slack, but I think we should avoid rolling back these changes as there was quite a bit of re-org and rewording in the docs and not just the addition of these two files. I have an outstanding task to also clean up the structure of the Vizro-AI docs and I fear it could all get a bit complex (my poor 🧠 won't handle it).

Could we instead focus on making sure the links readers follow are typically going to the latest "stable" (ie released) docs as we intended. The way to do this:

  1. search and replace https://vizro.readthedocs.io/projects/vizro-ai/en/latest/ for https://vizro.readthedocs.io/projects/vizro-ai/ so that users get the versioned/"stable" docs
  2. search and replace https://vizro-ai.readthedocs.io/ for https://vizro.readthedocs.io/projects/vizro-ai/
  3. Find any external links to Vizro-AI docs (e.g. links in README files rather than in built docs, links in blog posts, release notes, even on Slack) and fix them as per 1/2
  4. TEST!

Hey, independently of you I took a stab, slightly different strategy, I tried to replace all links to latest with https://vizro-ai.readthedocs.io/ as that seems the safest option? See this PR: #623

The 5 links which I could not replace are shown below, they refer to specific sections, where we would need stable to work:
Screenshot 2024-08-08 at 13 52 06
image

@stichbury Any objects to merge this PR quickly?

@stichbury
Copy link
Contributor

I have no objections to hardcoded latest where you need it since, well, you need it! Those pages need to be changed as soon as anything changes in the references (or put on standby to change) so it's fine to do it, if a bit annoying to maintain.

I think we're agreed with the other and you're flipping your changes. Thanks for doing this so swiftly! Ping me on Slack and I'll approve so you can merge ASAP.

@lingyielia lingyielia closed this Aug 8, 2024
@lingyielia lingyielia deleted the docs/temp_remove_dashboard_docs branch January 8, 2025 02:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Vizro-AI 🤖 Issue/PR that addresses Vizro-AI package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants