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

MIGRATION: Evaluate image and attachment handling #14513

Closed
toddfarmer opened this issue Oct 26, 2022 · 6 comments
Closed

MIGRATION: Evaluate image and attachment handling #14513

toddfarmer opened this issue Oct 26, 2022 · 6 comments

Comments

@toddfarmer
Copy link
Contributor

ASF Jira issues may have attached content, including images displayed inline in comments. This issue is a marker to evaluate how that content may migrate, and whether additional work may be required. Issue attachments may simply be referenced in an added comment, indicating attachments exist and can be retrieved from the source issue. Missing inline images (if not handled by migration) may be a bit more challenging to handle usefully.

@toddfarmer
Copy link
Contributor Author

By default, inline images render as broken image links in migrated content - see this example:

image

@toddfarmer
Copy link
Contributor Author

By adding some additional translation, it's possible to direct the inline image/attachment links in the migrated content back to the ASF Jira-hosted content. See this example.

Note that this points back to the original ASF Jira issue content, and the actual attachment has not been migrated to GitHub. This also means that if ASF Jira content is removed, inline content such as this will break.

@toddfarmer
Copy link
Contributor Author

There are currently 516 Jira issues with attachments.

@toddfarmer
Copy link
Contributor Author

It would be trivially easy to list the attachments with links to the content found in ASF Jira (not copying content into GitHub). Do we have strong feelings on needing to bring this referenced content over to GitHub itself, or can we allow migrated issues to point back to the content in ASF Jira? Because ASF Jira is world-readable, the content itself isn't restricted to registered Jira users. Any new attachments added would obviously end up in GitHub.

@toddfarmer
Copy link
Contributor Author

Unless there are objections, I plan to:

  1. Fix inline image links to point to the ASF Jira-hosted content from the source issue, without migrating/copying any content.
  2. Add a list of issue attachments at time of migration to the issue description with links to the ASF Jira issue content (again, without copying any of that content to GitHub issues).

Both are demonstrated in this example issue: https://github.com/toddfarmer/test_import/issues/313

@jorisvandenbossche
Copy link
Member

Sounds good!

@rok rok closed this as completed Jan 8, 2023
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

No branches or pull requests

3 participants