Skip to content

Commit

Permalink
Update README to point Enterprise Users to website instead
Browse files Browse the repository at this point in the history
Since Enterprise users are still a minority, now they get a nicely
formatted help article instead of their own paragraph taking up space in
our README file.
  • Loading branch information
IQAndreas committed Jun 1, 2014
1 parent 5fd5efd commit 016e8f7
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ Fork of one of the tools by [Max Korenkov](https://github.com/mkorenkov) separat

#### Usage ####

Rename `config.ini.sample` to `config.ini`, and edit the fields to match your login info and repository info. _NOTE: If you want to use a different credentials for the source and target repositories, please see the below section for Enterprise Users._ Store the config file in the same folder as the `gh-issues-import.py` script, or store it in a different folder, using the `--config <file>` option to specify which config file to load in.
The script will by default look for a file named `config.ini` located in the same folder as the Python script. For a list of all possible configuration options, see [Configuration](http://www.iqandreas.com/github-issues-import/configuration/).

To quickly get started, rename `config.ini.sample` to `config.ini`, and edit the fields to match your login info and repository info. If you want to use a different credentials for the source and target repositories, please see [Configuration: Enterprise Accounts and Advanced Login Options](http://www.iqandreas.com/github-issues-import/configuration/#enterprise). Store the config file in the same folder as the `gh-issues-import.py` script, or store it in a different folder, using the `--config <file>` option to specify which config file to load in.

**Warning:** The password is stored in plain-text, so avoid storing the config file in a public repository. To avoid this, you can instead pass the username and/or password as arguments by using the `-u <username>` and `-p <password>` flags respectively. If the username or password is not passed in from either of these locations, the user will be prompted for them when the script runs.

Expand All @@ -27,12 +29,6 @@ Or to only import specific issues, run the script and include the issue numbers

Some config options can be passed as arguments. For a full list, see [the the _Arguments_ page](http://www.iqandreas.com/github-issues-import/arguments/), or run the script using the `--help` flag.

#### Enterprise Users ####

If you are using [GitHub for Enterprise](https://enterprise.github.com/), thanks to the help of [Joshua Rountree](https://github.com/joshuairl), there is support for that. These changes also allow you to specify a different username and password for the source and target repositories, even if both of them are hosted on GitHub.

Use the [`config-enterprise.ini.sample`](config-enterprise.ini.sample) file as a template (renaming it to `config.ini`, or using the `--config <file>` flag). The command line options `--username` and `--password` do not allow you to specify which repository the credentials apply to, so unless you use the same credentials for both servers, a config file _must_ be used.

#### Result ####

Every issue imported will create a new issue in the target repository. Remember that the ID of the issue in the new repository will most likely not be the same as the ID of the original issue. Keep this in mind when writing commit messages such as _"Closes #25"_.
Expand Down

0 comments on commit 016e8f7

Please sign in to comment.