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

Moved images & updated legacy links #301

Merged
merged 3 commits into from
Sep 27, 2023
Merged

Moved images & updated legacy links #301

merged 3 commits into from
Sep 27, 2023

Conversation

cwarnermm
Copy link
Member

@cwarnermm cwarnermm commented Sep 6, 2023

  • Gitbook images moved to /assets directory.
  • /docs folder removed since GitBook pages are no longer being sync'd to GitHub.
  • updated links on the page to pages/images

@cwarnermm cwarnermm added the 2: Dev Review Requires review by a core committer label Sep 6, 2023
@codecov
Copy link

codecov bot commented Sep 6, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (de8de08) 23.51% compared to head (c245a68) 23.51%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #301   +/-   ##
=======================================
  Coverage   23.51%   23.51%           
=======================================
  Files           9        9           
  Lines        1212     1212           
=======================================
  Hits          285      285           
  Misses        874      874           
  Partials       53       53           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@cwarnermm cwarnermm added 4: Reviews Complete All reviewers have approved the pull request and removed 2: Dev Review Requires review by a core committer labels Sep 7, 2023
Copy link
Collaborator

@hanzei hanzei left a comment

Choose a reason for hiding this comment

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

All files in assets get included in th plugin bundle. Are we sure that we want the docs images in there?

@cwarnermm
Copy link
Member Author

That's a good question, @hanzei. Do all of the plugins work similarly? CC @mickmister

@hanzei
Copy link
Collaborator

hanzei commented Sep 8, 2023

Yes, all plugins use the assets folder for bundle related files.

@cwarnermm
Copy link
Member Author

Thanks, @hanzei. Since all plugins operate the same way, and the docs migration work applies the same migration changes across each plugin repo, I feel we're offering a consistent experience across the community supported plugins. Any concerns about proceeding with this PR from your perspective?

@cwarnermm cwarnermm requested a review from hanzei September 11, 2023 14:11
@mickmister
Copy link
Contributor

@cwarnermm The assets folder is reserved for application-related files that the plugin's server component can access at runtime. I would prefer using a separate folder like docs, to house these doc-related images, even if that folder is no longer associated with GitBooks.

@cwarnermm
Copy link
Member Author

Thanks for clarifying, @mickmister. I'm open to moving the docs image files that came via GitBooks.

However, what I'm not clear on is whether I need to revisit all of the community supported plugin repos again and move the image files that were moved to the /assets directory. Please advise.

@mickmister
Copy link
Contributor

However, what I'm not clear on is whether I need to revisit all of the community supported plugin repos again and move the image files that were moved to the /assets directory. Please advise.

It technically doesn't cause any functional issues, so it if it's a lot of rework I would say it's not necessary. Having the assets folder be only what the plugin uses just gives us a way to quickly see its dependencies on some static files, and may cause confusion if there are files there not imported by the plugin. If the PRs are still open and it seems like a trivial change, then I think why not, but not a requirement.

@cwarnermm
Copy link
Member Author

cwarnermm commented Sep 11, 2023

The request to keep the /assets directory clean makes a lot of sense, and I'm happy to take that approach with this PR and the remaining open PRs.

For all of the GitHub plugin repos that have already been approved and merged, we'll create Help Wanted tickets for remaining work.

@cwarnermm
Copy link
Member Author

@hanzei - Let's merge this PR as-is. It's the last one to be merged as part of the v9.0 release. I'll create a help wanted ticket for Hacktoberfest to get the doc image assets moved out of the /assets directory.

@cwarnermm cwarnermm enabled auto-merge (squash) September 26, 2023 16:22
@hanzei
Copy link
Collaborator

hanzei commented Sep 27, 2023

/check-cla

@hanzei
Copy link
Collaborator

hanzei commented Sep 27, 2023

/update-branch

@hanzei
Copy link
Collaborator

hanzei commented Sep 27, 2023

@toninis Can you please check why Mattermod status doesn't get updated?

@cwarnermm cwarnermm merged commit 07852e0 into master Sep 27, 2023
@cwarnermm cwarnermm deleted the moved-images-links branch September 27, 2023 10:08
@toninis
Copy link

toninis commented Sep 27, 2023

@toninis Can you please check why Mattermod status doesn't get updated?

Should be ok 👌🏼

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4: Reviews Complete All reviewers have approved the pull request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants