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(import_datasources): Remove legacy documentation and update current use #27290

Merged
merged 8 commits into from
Mar 5, 2024

Conversation

ddxv
Copy link
Contributor

@ddxv ddxv commented Feb 28, 2024

SUMMARY

The documentation was still referencing the "legacy_import_datasources". I updated to the current expected use for ZIP files and --username option based on #27154.

I have removed the documentation which was for legacy_import_datasources based on the assumption that this is not expected to be supported.

If we would like to keep supporting the legacy_import_datasources I can add it back into the docs with it's own titled section.

Please let me know what works best.

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

@github-actions github-actions bot added the doc Namespace | Anything related to documentation label Feb 28, 2024
@sfirke
Copy link
Member

sfirke commented Feb 28, 2024

I'm unfamiliar with the technical aspect of this but appreciate you keeping the docs updated! My only concern would be if this only applies to the latest version (I see the PR is tagged 4.0 / 3.1) and we would want to keep the older info for users of older versions. Did this documentation even work before your patch, it sounds like it was broken? If it worked for a reasonably recent version (say 2.0.0 or later) I'd be inclined to preserve it.

Ideally there'd be a way to link to an older static version of the docs, but I don't think that's possible, so anything useful could be preserved in a section labeled as such.

@pull-request-size pull-request-size bot added size/S and removed size/M labels Feb 28, 2024
@ddxv
Copy link
Contributor Author

ddxv commented Feb 28, 2024

@sfirke thanks for the input. I went ahead and undid the deletion of the legacy documentation, and instead labled it as Legacy Import Datasources.

I also added clarification for using the VERSIONED_EXPORT which was used in an if / else switch in versions 2/3 for accepting either the ZIP file or YAML file(s).

@sfirke
Copy link
Member

sfirke commented Feb 29, 2024

Thanks for the changes. To check my understanding, are there three scenarios to cover:

  1. Importing 4.0.0+ dashboards into a 4.0.0+ instance = use import_datasources
  2. Importing <4.0.0 dashboards into a 4.0.0+ instance = use legacy_import_datasources
  3. Importing <4.0.0 dashboards into a <4.0.0 instance = use import_datasources

Is that right? Right now 1. is covered, but the legacy piece could be clearer in how it covers both 2 & 3.

Sorry if this feels like I'm belaboring this or if I'm misunderstanding.

@pull-request-size pull-request-size bot added size/M and removed size/S labels Feb 29, 2024
@ddxv
Copy link
Contributor Author

ddxv commented Feb 29, 2024

Thanks for the changes. To check my understanding, are there three scenarios to cover:

1. Importing 4.0.0+ dashboards into a 4.0.0+ instance = use `import_datasources`

2. Importing <4.0.0 dashboards into a 4.0.0+ instance = use `legacy_import_datasources`

3. Importing <4.0.0 dashboards into a <4.0.0 instance = use `import_datasources`

Is that right? Right now 1. is covered, but the legacy piece could be clearer in how it covers both 2 & 3.

Sorry if this feels like I'm belaboring this or if I'm misunderstanding.

@sfirke Glad you brought that up, I hadn't considered upgrading across versions as I had gotten into this from just deploying a specific versions. Your 3 points are definitely valid, so I added a couple more sections to the Legacy section to cover them.

Copy link
Member

@sfirke sfirke left a comment

Choose a reason for hiding this comment

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

This is looking good! Just one little suggestion and a little question. Thank you @ddxv for addressing the various scenarios one can face here 🙏

@sfirke sfirke merged commit 721977a into apache:master Mar 5, 2024
22 checks passed
@sfirke
Copy link
Member

sfirke commented Mar 5, 2024

thank you @ddxv for this great update to the docs! 🙌

sfirke added a commit to sfirke/superset that referenced this pull request Mar 22, 2024
qleroy pushed a commit to qleroy/superset that referenced this pull request Apr 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Namespace | Anything related to documentation size/M
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants