From 187267bc6e05337e310a4a58f79b91ed602b6ff2 Mon Sep 17 00:00:00 2001 From: Ellen Marie Dash Date: Thu, 16 Jan 2020 17:54:28 -0500 Subject: [repo move] Update GitHub URL in doc/. --- doc/POLICIES.md | 2 +- doc/contributing/COMMUNITY.md | 4 ++-- doc/contributing/HOW_YOU_CAN_HELP.md | 10 +++++----- doc/contributing/ISSUES.md | 2 +- doc/contributing/README.md | 18 +++++++++--------- doc/development/NEW_FEATURES.md | 2 +- doc/development/PULL_REQUESTS.md | 2 +- doc/development/SETUP.md | 2 +- doc/documentation/README.md | 4 ++-- doc/documentation/WRITING.md | 6 +++--- doc/playbooks/RELEASING.md | 8 ++++---- doc/playbooks/TEAM_CHANGES.md | 8 ++++---- 12 files changed, 34 insertions(+), 34 deletions(-) (limited to 'doc') diff --git a/doc/POLICIES.md b/doc/POLICIES.md index f01cfd6856..81a8a72f82 100644 --- a/doc/POLICIES.md +++ b/doc/POLICIES.md @@ -68,7 +68,7 @@ Major version releases should be cut no more than once per year, ideally between ### Enforcement guidelines -First off, Bundler's policies and enforcement of those policies are subsidiary to [Bundler's code of conduct](https://github.com/bundler/bundler/blob/master/CODE_OF_CONDUCT.md) in any case where they conflict. The first priority is treating human beings with respect and empathy, and figuring out project guidelines and sticking to them will always come after that. +First off, Bundler's policies and enforcement of those policies are subsidiary to [Bundler's code of conduct](https://github.com/rubygems/bundler/blob/master/CODE_OF_CONDUCT.md) in any case where they conflict. The first priority is treating human beings with respect and empathy, and figuring out project guidelines and sticking to them will always come after that. When it comes to carrying out our own policies, we're all regular humans trying to do the best we can. There will probably be times when we don't stick to our policies or goals. If you notice a discrepancy between real-life actions and these policies and goals, please bring it up! We want to make sure that our actions and our policies line up, and that our policies exemplify our goals. diff --git a/doc/contributing/COMMUNITY.md b/doc/contributing/COMMUNITY.md index 2606d7e46a..77cb97ec63 100644 --- a/doc/contributing/COMMUNITY.md +++ b/doc/contributing/COMMUNITY.md @@ -2,9 +2,9 @@ Community is an important part of all we do. If you'd like to be part of the Bundler community, you can jump right in and start helping make Bundler better for everyone who uses it. -It would be tremendously helpful to have more people answering questions about Bundler (and often simply about [RubyGems](https://github.com/rubygems/rubygems) or Ruby itself) in our [issue tracker](https://github.com/bundler/bundler/issues) or on [Stack Overflow](https://stackoverflow.com/questions/tagged/bundler). +It would be tremendously helpful to have more people answering questions about Bundler (and often simply about [RubyGems](https://github.com/rubygems/rubygems) or Ruby itself) in our [issue tracker](https://github.com/rubygems/bundler/issues) or on [Stack Overflow](https://stackoverflow.com/questions/tagged/bundler). -Additional documentation and explanation is always helpful, too. If you have any suggestions for the Bundler website [bundler.io](https://bundler.io), we would absolutely love it if you opened an issue or pull request on the [bundler-site](https://github.com/bundler/bundler-site) repository. +Additional documentation and explanation is always helpful, too. If you have any suggestions for the Bundler website [bundler.io](https://bundler.io), we would absolutely love it if you opened an issue or pull request on the [bundler-site](https://github.com/rubygems/bundler-site) repository. Sharing your experiences and discoveries by writing them up is a valuable way to help others who have similar problems or experiences in the future. You can write a blog post, create an example and commit it to GitHub, take screenshots, or make videos. diff --git a/doc/contributing/HOW_YOU_CAN_HELP.md b/doc/contributing/HOW_YOU_CAN_HELP.md index 771d17e180..8d85d748d0 100644 --- a/doc/contributing/HOW_YOU_CAN_HELP.md +++ b/doc/contributing/HOW_YOU_CAN_HELP.md @@ -6,22 +6,22 @@ If at any point you get stuck, here's how to [get in touch with the Bundler team ## First contribution suggestions -We track [small bugs and features](https://github.com/bundler/bundler/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) so that anyone who wants to help can start with something that's not too overwhelming. +We track [small bugs and features](https://github.com/rubygems/bundler/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) so that anyone who wants to help can start with something that's not too overwhelming. Generally, great ways to get started helping out with Bundler are: - using prerelease versions (run `gem install bundler --pre`) - - [reporting bugs you encounter or suggesting new features](https://github.com/bundler/bundler/issues/new) + - [reporting bugs you encounter or suggesting new features](https://github.com/rubygems/bundler/issues/new) - see our [issues guide](ISSUES.md) for help on filing issues - see the [new features documentation](../development/NEW_FEATURES.md) for more - adding to or editing [the Bundler documentation website](https://bundler.io) and [Bundler man pages](https://bundler.io/man/bundle.1.html) - [checking issues for completeness](BUG_TRIAGE.md) - closing issues that are not complete - - adding a failing test for reproducible [reported bugs](https://github.com/bundler/bundler/issues) - - reviewing [pull requests](https://github.com/bundler/bundler/pulls) and suggesting improvements + - adding a failing test for reproducible [reported bugs](https://github.com/rubygems/bundler/issues) + - reviewing [pull requests](https://github.com/rubygems/bundler/pulls) and suggesting improvements - improving existing code, including suggestions from [PullReview](https://www.pullreview.com/github/bundler/bundler/reviews/master) or [CodeClimate](https://codeclimate.com/github/bundler/bundler) - writing code (no patch is too small! fix typos or bad whitespace) - get started setting up your dev environment with [these instructions](../development/SETUP.md) - - backfilling [unit tests](https://github.com/bundler/bundler/tree/master/spec/bundler) for modules that lack coverage. + - backfilling [unit tests](https://github.com/rubygems/bundler/tree/master/spec/bundler) for modules that lack coverage. If nothing on those lists looks good, [talk to us](https://slack.bundler.io/), and we'll figure out what you can help with. We can absolutely use your help, no matter what level of programming skill you have at the moment. diff --git a/doc/contributing/ISSUES.md b/doc/contributing/ISSUES.md index 361350badd..602a9c5458 100644 --- a/doc/contributing/ISSUES.md +++ b/doc/contributing/ISSUES.md @@ -46,6 +46,6 @@ If your version of Bundler does not have the `bundle env` command, then please i If you have either `rubygems-bundler` or `open_gem` installed, please try removing them and then following the troubleshooting steps above before opening a new ticket. -[Create a gist](https://gist.github.com) containing all of that information, then visit the [Bundler issue tracker](https://github.com/bundler/bundler/issues) and [create a ticket](https://github.com/bundler/bundler/issues/new) describing your problem and linking to your gist. +[Create a gist](https://gist.github.com) containing all of that information, then visit the [Bundler issue tracker](https://github.com/rubygems/bundler/issues) and [create a ticket](https://github.com/rubygems/bundler/issues/new) describing your problem and linking to your gist. Thanks for reporting issues and helping make Bundler better! diff --git a/doc/contributing/README.md b/doc/contributing/README.md index d08c7977b8..9e6a6fc482 100644 --- a/doc/contributing/README.md +++ b/doc/contributing/README.md @@ -4,11 +4,11 @@ Thank you for your interest in making Bundler better! We welcome contributions f Before submitting a contribution, read through the following guidelines: -* [Bundler Code of Conduct](https://github.com/bundler/bundler/blob/master/CODE_OF_CONDUCT.md) (By participating in Bundler, you agree to abide by the terms laid out in the CoC.) -* [Issue Reporting Guidelines](https://github.com/bundler/bundler/blob/master/doc/contributing/ISSUES.md) -* [Pull Request Guidelines](https://github.com/bundler/bundler/blob/master/doc/development/PULL_REQUESTS.md) +* [Bundler Code of Conduct](https://github.com/rubygems/bundler/blob/master/CODE_OF_CONDUCT.md) (By participating in Bundler, you agree to abide by the terms laid out in the CoC.) +* [Issue Reporting Guidelines](https://github.com/rubygems/bundler/blob/master/doc/contributing/ISSUES.md) +* [Pull Request Guidelines](https://github.com/rubygems/bundler/blob/master/doc/development/PULL_REQUESTS.md) -And be sure to [set up your development environment](https://github.com/bundler/bundler/blob/master/doc/development/SETUP.md). +And be sure to [set up your development environment](https://github.com/rubygems/bundler/blob/master/doc/development/SETUP.md). ## Feature Requests @@ -18,11 +18,11 @@ To request substantial changes to Bundler and/or Bundler documentation, please r Here are the different ways you can start contributing to the Bundler project: -* [First contribution suggestions](https://github.com/bundler/bundler/blob/master/doc/contributing/HOW_YOU_CAN_HELP.md) -* [Adding new features](https://github.com/bundler/bundler/blob/master/doc/development/NEW_FEATURES.md) -* [Triaging bugs](https://github.com/bundler/bundler/blob/master/doc/contributing/BUG_TRIAGE.md) -* [Writing documentation](https://github.com/bundler/bundler/blob/master/doc/documentation/WRITING.md) -* [Community engagement](https://github.com/bundler/bundler/blob/master/doc/contributing/COMMUNITY.md) +* [First contribution suggestions](https://github.com/rubygems/bundler/blob/master/doc/contributing/HOW_YOU_CAN_HELP.md) +* [Adding new features](https://github.com/rubygems/bundler/blob/master/doc/development/NEW_FEATURES.md) +* [Triaging bugs](https://github.com/rubygems/bundler/blob/master/doc/contributing/BUG_TRIAGE.md) +* [Writing documentation](https://github.com/rubygems/bundler/blob/master/doc/documentation/WRITING.md) +* [Community engagement](https://github.com/rubygems/bundler/blob/master/doc/contributing/COMMUNITY.md) ## Supporting Bundler diff --git a/doc/development/NEW_FEATURES.md b/doc/development/NEW_FEATURES.md index fe8b705d7d..0e9864deff 100644 --- a/doc/development/NEW_FEATURES.md +++ b/doc/development/NEW_FEATURES.md @@ -2,7 +2,7 @@ If you would like to add a new feature to Bundler, please follow these steps: - 1. [Create an issue](https://github.com/bundler/bundler/issues/new) with the [`feature-request` label](https://github.com/bundler/bundler/labels/type:%20feature-request) to discuss your feature. + 1. [Create an issue](https://github.com/rubygems/bundler/issues/new) with the [`feature-request` label](https://github.com/rubygems/bundler/labels/type:%20feature-request) to discuss your feature. 2. Base your commits on the master branch, since we follow [SemVer](https://semver.org) and don't add new features to old releases. 3. Commit the code and at least one test covering your changes to a feature branch in your fork. 4. Send us a [pull request](PULL_REQUESTS.md) from your feature branch. diff --git a/doc/development/PULL_REQUESTS.md b/doc/development/PULL_REQUESTS.md index 497febfe71..313a885033 100644 --- a/doc/development/PULL_REQUESTS.md +++ b/doc/development/PULL_REQUESTS.md @@ -29,7 +29,7 @@ Ex. For a pull request that changes something with `bundle update`, you might ru Please ensure that the commit messages included in the pull request __do not__ have the following: - `@tag` GitHub user or team references (ex. `@indirect` or `@bundler/core`) - - `#id` references to issues or pull requests (ex. `#43` or `bundler/bundler-site#12`) + - `#id` references to issues or pull requests (ex. `#43` or `rubygems/bundler-site#12`) If you want to use these mechanisms, please instead include them in the pull request description. This prevents multiple notifications or references being created on commit rebases or pull request/branch force pushes. diff --git a/doc/development/SETUP.md b/doc/development/SETUP.md index 6af7c07145..4b91a83833 100644 --- a/doc/development/SETUP.md +++ b/doc/development/SETUP.md @@ -2,7 +2,7 @@ Bundler doesn't use a Gemfile to list development dependencies, because when we tried it we couldn't tell if we were awake or it was just another level of dreams. To work on Bundler, you'll probably want to do a couple of things: -1. [Fork the Bundler repo](https://github.com/bundler/bundler), and clone the fork onto your machine. ([Follow this tutorial](https://help.github.com/articles/fork-a-repo/) for instructions on forking a repo.) +1. [Fork the Bundler repo](https://github.com/rubygems/bundler), and clone the fork onto your machine. ([Follow this tutorial](https://help.github.com/articles/fork-a-repo/) for instructions on forking a repo.) 2. Install `groff-base` and `graphviz` packages using your package manager: diff --git a/doc/documentation/README.md b/doc/documentation/README.md index 63e73b1491..48d6979746 100644 --- a/doc/documentation/README.md +++ b/doc/documentation/README.md @@ -7,12 +7,12 @@ Currently, Bundler has two main sources of documentation: 1. built-in `help` (including usage information and man pages) 2. [Bundler documentation site](https://bundler.io) -If you have a suggestion or proposed change for [bundler.io](https://bundler.io), please open an issue or send a pull request to the [bundler-site](https://github.com/bundler/bundler-site) repository. +If you have a suggestion or proposed change for [bundler.io](https://bundler.io), please open an issue or send a pull request to the [bundler-site](https://github.com/rubygems/bundler-site) repository. Not sure where to write documentation? In general, follow these guidelines: * For an explanation of a specific Bundler command (ex: `bundle clean`): make changes to the man pages -* For longer explanations or usage guides (ex: "Using Bundler with Rails"): create new documentation within the [bundler-site](https://github.com/bundler/bundler-site) repository +* For longer explanations or usage guides (ex: "Using Bundler with Rails"): create new documentation within the [bundler-site](https://github.com/rubygems/bundler-site) repository If you are unsure where to begin, ping [@feministy](https://github.com/feministy) or [@indirect](https://github.com/indirect) in the Bundler Slack ([get an invite here](../contributing/GETTING_HELP.md)). diff --git a/doc/documentation/WRITING.md b/doc/documentation/WRITING.md index 3975b57043..e529c0af74 100644 --- a/doc/documentation/WRITING.md +++ b/doc/documentation/WRITING.md @@ -55,11 +55,11 @@ $ bin/rspec ./spec/quality_spec.rb # Writing docs for [the Bundler documentation site](https://bundler.io) -If you'd like to submit a pull request for any of the primary commands or utilities on [the Bundler documentation site](https://bundler.io), please follow the instructions above for writing documentation for man pages from the `bundler/bundler` repository. They are the same in each case. +If you'd like to submit a pull request for any of the primary commands or utilities on [the Bundler documentation site](https://bundler.io), please follow the instructions above for writing documentation for man pages from the `rubygems/bundler` repository. They are the same in each case. -Note: Editing `.ronn` files from the `bundler/bundler` repository for the primary commands and utilities documentation is all you need 🎉. There is no need to manually change anything in the `bundler/bundler-site` repository, because the man pages and the docs for primary commands and utilities on [the Bundler documentation site](https://bundler.io) are one in the same. They are generated automatically from the `bundler/bundler` repository's `.ronn` files from the `rake man/build` command. In other words, after updating `.ronn` file and running `rake man/build` in `bundler`, `.ronn` files map to the auto-generated files in the `source/man` directory of `bundler-site`. +Note: Editing `.ronn` files from the `rubygems/bundler` repository for the primary commands and utilities documentation is all you need 🎉. There is no need to manually change anything in the `rubygems/bundler-site` repository, because the man pages and the docs for primary commands and utilities on [the Bundler documentation site](https://bundler.io) are one in the same. They are generated automatically from the `rubygems/bundler` repository's `.ronn` files from the `rake man/build` command. In other words, after updating `.ronn` file and running `rake man/build` in `bundler`, `.ronn` files map to the auto-generated files in the `source/man` directory of `bundler-site`. -Additionally, if you'd like to add a guide or tutorial: in the `bundler/bundler-site` repository, go to `/bundler-site/source/current_version_of_bundler/guides` and add [a new Markdown file](https://guides.github.com/features/mastering-markdown/) (with an extension ending in `.md`). Be sure to correctly format the title of your new guide, like so: +Additionally, if you'd like to add a guide or tutorial: in the `rubygems/bundler-site` repository, go to `/bundler-site/source/current_version_of_bundler/guides` and add [a new Markdown file](https://guides.github.com/features/mastering-markdown/) (with an extension ending in `.md`). Be sure to correctly format the title of your new guide, like so: ``` --- title: RubyGems.org SSL/TLS Troubleshooting Guide diff --git a/doc/playbooks/RELEASING.md b/doc/playbooks/RELEASING.md index 8178f2f925..c618488efb 100644 --- a/doc/playbooks/RELEASING.md +++ b/doc/playbooks/RELEASING.md @@ -39,9 +39,9 @@ When we cherry-pick, we cherry-pick the merge commits using the following comman $ git cherry-pick -m 1 MERGE_COMMIT_SHAS ``` -For example, for PR [#5029](https://github.com/bundler/bundler/pull/5029), we -cherry picked commit [dd6aef9](https://github.com/bundler/bundler/commit/dd6aef97a5f2e7173f406267256a8c319d6134ab), -not [4fe9291](https://github.com/bundler/bundler/commit/4fe92919f51e3463f0aad6fa833ab68044311f03) +For example, for PR [#5029](https://github.com/rubygems/bundler/pull/5029), we +cherry picked commit [dd6aef9](https://github.com/rubygems/bundler/commit/dd6aef97a5f2e7173f406267256a8c319d6134ab), +not [4fe9291](https://github.com/rubygems/bundler/commit/4fe92919f51e3463f0aad6fa833ab68044311f03) using: ```bash @@ -95,7 +95,7 @@ Here's the checklist for releasing new minor versions: Wait! You're not done yet! After your prelease looks good: * [ ] Update `version.rb` to a final version (i.e. 1.12.0) -* [ ] In the [bundler/bundler-site](https://github.com/bundler/bundler-site) repo, +* [ ] In the [rubygems/bundler-site](https://github.com/rubygems/bundler-site) repo, copy the previous version's docs to create a new version (e.g. `cp -r v1.11 v1.12`) * [ ] Update the new docs as needed, paying special attention to the "What's new" page for this version diff --git a/doc/playbooks/TEAM_CHANGES.md b/doc/playbooks/TEAM_CHANGES.md index f6a1e26bff..2d500d013d 100644 --- a/doc/playbooks/TEAM_CHANGES.md +++ b/doc/playbooks/TEAM_CHANGES.md @@ -25,7 +25,7 @@ Interested in adding someone to the team? Here's the process. ## Removing a team member -When the conditions in [POLICIES](https://github.com/bundler/bundler/blob/master/doc/POLICIES.md#maintainer-team-guidelines) are met, or when team members choose to retire, here's how to remove someone from the team. +When the conditions in [POLICIES](https://github.com/rubygems/bundler/blob/master/doc/POLICIES.md#maintainer-team-guidelines) are met, or when team members choose to retire, here's how to remove someone from the team. - Remove them from the owners list on RubyGems.org by running ``` @@ -36,8 +36,8 @@ When the conditions in [POLICIES](https://github.com/bundler/bundler/blob/master - Remove them from the [maintainers team][org_team] on GitHub - Remove them from the maintainers Slack channel -[policies]: https://github.com/bundler/bundler/blob/master/doc/POLICIES.md#bundler-policies +[policies]: https://github.com/rubygems/bundler/blob/master/doc/POLICIES.md#bundler-policies [org_team]: https://github.com/orgs/bundler/teams/maintainers/members [team]: https://bundler.io/contributors.html -[maintainers]: https://github.com/bundler/bundler-site/blob/02483d3f79f243774722b3fc18a471ca77b1c424/source/contributors.html.haml#L25 -[list]: https://github.com/bundler/bundler-site/blob/02483d3f79f243774722b3fc18a471ca77b1c424/lib/tasks/contributors.rake#L8 +[maintainers]: https://github.com/rubygems/bundler-site/blob/02483d3f79f243774722b3fc18a471ca77b1c424/source/contributors.html.haml#L25 +[list]: https://github.com/rubygems/bundler-site/blob/02483d3f79f243774722b3fc18a471ca77b1c424/lib/tasks/contributors.rake#L8 -- cgit v1.2.1