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

Add links to dev guides from user guides #708

Merged
merged 1 commit into from
Jul 19, 2022

Conversation

tnir
Copy link
Collaborator

@tnir tnir commented Jul 19, 2022

What was the end-user problem that led to this PR?

note: also was relevant to #691 but not any more.

What was your diagnosis of the problem?

Links can be added at minimum. All developer guides, generated from the main repo, already exist on Web site.

What is your fix for the problem, implemented in this PR?

Adds a link from the sidebar in each guide (not command references) to the top of contribution and developer guide.

Why did you choose this fix out of the possible options?

  1. A crawler and/or a user can find the entrance of from the Bundler Web site with this minimal change.
  2. We can add dev guides on https://bundler.io/docs.html, but I skipped it at this moment since they are versioned.

Signed-off-by: Takuya Noguchi [email protected]

@deivid-rodriguez deivid-rodriguez temporarily deployed to bundler-site-tnir-activ-wndzqd July 19, 2022 06:24 Inactive
Copy link
Member

@deivid-rodriguez deivid-rodriguez left a comment

Choose a reason for hiding this comment

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

I think the distinction between "Guides" and "Developer Guides" is not very clear, since many Bundler users will call themselves developers.

Should we instead add a new link to the main list, called "Contributing to Bundler" or "Bundler contributor guidelines" or something like that?

All developer guides, are generated from the main repo, already exist
on Web site.

Signed-off-by: Takuya Noguchi <[email protected]>
@tnir tnir force-pushed the tnir-activate-dev-guides-707 branch from 83139ab to 321fbf6 Compare July 19, 2022 11:37
@deivid-rodriguez deivid-rodriguez temporarily deployed to bundler-site-tnir-activ-wndzqd July 19, 2022 11:37 Inactive
@tnir
Copy link
Collaborator Author

tnir commented Jul 19, 2022

I agree with you that the distinction between "Guides" and "Developer Guides" is not very clear!

Let me revert all in the previous commit and just add a link from the latest docs to "Contribution guides" i.e. https://bundler.io/docs.html.

@tnir tnir requested a review from deivid-rodriguez July 19, 2022 11:44
@deivid-rodriguez deivid-rodriguez merged commit 7269c93 into master Jul 19, 2022
@deivid-rodriguez deivid-rodriguez deleted the tnir-activate-dev-guides-707 branch July 19, 2022 12:04
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

Successfully merging this pull request may close these issues.

2 participants