Skip to content

Plugin/Loader doc pages should have clear, explicit links to their respective repos #1107

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.

Sign up for GitHub

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

Jump to bottom
Closed
dmitriid opened this issue Apr 14, 2017 · 5 comments · Fixed by #1147
Closed

Plugin/Loader doc pages should have clear, explicit links to their respective repos #1107

dmitriid opened this issue Apr 14, 2017 · 5 comments · Fixed by #1147
Assignees
@skipjack
Labels
Loaders Plugins UI/UX

Comments

@dmitriid
Copy link
Contributor

dmitriid commented Apr 14, 2017 •
edited
Loading

In addition to #1076 :

Loaders and plugins are not a part of webpack. And they are not always a part of webpack-contrib. Their documentation pages should have a link to the plugin's/loader's respective Github repo.

UPDATED

Explicit is better than implicit. Currently the only ways to get to the respective repos is:

Way 1:

  • Hover over "Edit this page"
  • Notice that it leads to the correct repo
  • Click it
  • Click on Code/Issues/whatever you actually need in the repo

Way2:

  • Google the name
  • Click first link in search results

This assumes that a person interested in a project's repo will figure out that they have to click "Edit this page" to get to the repo. Which is counterintuitive to say the least.
@simon04
Copy link
Collaborator

simon04 commented Apr 14, 2017

A link already exists: "Edit this page" links to the corresponding GitHub project, more specifically to its README.

@dmitriid
Copy link
Contributor Author

dmitriid commented Apr 14, 2017 •
edited
Loading

Yes. It's a link to the editing page for the README page. I personally didn't even think on clicking it (or even look where it leads), because usually I have no intention to edit a README.

I might want to go the project's Github page and file an issue, for example. Things must be made as explicit as possible.

(On a grumpy note: honestly, what is it with webpack team and clear unobstructed communication?)

@dmitriid dmitriid changed the title Plugin/Loader doc pages should have links to their respective repos Plugin/Loader doc pages should have clear, explicit links to their respective repos Apr 14, 2017
@skipjack skipjack self-assigned this Apr 15, 2017
@skipjack
Copy link
Collaborator

I can look into this one.

@dmitriid
Copy link
Contributor Author

Awesome!

skipjack added a commit that referenced this issue Apr 23, 2017
@skipjack
feat(page): display "jump to repository" url for external documentati…
7f97222 
…on (e.g. plugins/loaders)

Break page links out to their own component to isolate the logic and styling a bit. Remove
icons as their alignment and weights are a bit off. This should likely be re-visited later on
as they would look better with some nice icons.

Resolves #1107
@skipjack skipjack mentioned this issue Apr 23, 2017
Merged
skipjack added a commit that referenced this issue Apr 24, 2017
@skipjack
feat(page): display "jump to repository" url for external documentati…
3176912 
…on (e.g. plugins/loaders)

Break page links out to their own component to isolate the logic and styling a bit. Remove
icons as their alignment and weights are a bit off. This should likely be re-visited later on
as they would look better with some nice icons.

Resolves #1107
@dmitriid
Copy link
Contributor Author

This looks super nice. Awesome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@skipjack skipjack

Labels
Loaders Plugins UI/UX
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add "Jump to Repository" Link webpack/webpack.js.org
3 participants
@dmitriid @simon04 @skipjack