Skip to content

Remove mentions about index-co #2493

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

Merged
merged 2 commits into from
May 12, 2020
Merged

Remove mentions about index-co #2493

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d21bb60
Remove mentions about `index-co`
JohnTitor May 6, 2020
ed7dbbe
Address code review
JohnTitor May 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/ARCHITECTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ These files and directories have to do with the backend:
* `src/` - The backend's source code
* `target/` - Compiled output, including dependencies and final binary artifacts - (ignored in
`.gitignore`)
* `tmp/index-co` - The registry repository; in production this is cloned from Github and in
* `tmp/index-bare` - The registry repository; in production this is cloned from Github and in
development from `tmp/index-bare` - (ignored in `.gitignore`)

The backend stores information in a Postgres database.
Expand Down Expand Up @@ -98,8 +98,7 @@ local development environment
* `script/init-local-index.sh` - Creates registry repositories used during development
* `tmp/` - Temporary files created during development; when deployed on Heroku this is the only
writable directory - (ignored in `.gitignore`)
* `tmp/index-bare` - A bare git repository, used as the origin for `tmp/index-co` during
development - (ignored in `.gitignore`)
* `tmp/index-bare` - A bare git repository during development - (ignored in `.gitignore`)
* `.github/workflows/*` - Configuration for continuous integration at [GitHub Actions]
* `.watchmanconfig` - Use by Ember CLI to efficiently watch for file changes if you install watchman

Expand Down
10 changes: 5 additions & 5 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,13 +450,13 @@ live crates.io, you won't be able to publish that crate locally.
In your crate directory, run:

```
cargo publish --index file:///path/to/your/crates.io/checkout/tmp/index-co
cargo publish --index file:///path/to/your/crates.io/tmp/index-bare --token $YOUR_TOKEN
```

> If you're using an older version of cargo you should use `--host` instead of `--index`.

where `file:///path/to/your/crates.io/checkout` is the directory that you have
crates.io's code in, and `tmp/index-co` is the directory with the git index
crates.io's code in, and `tmp/index-bare` is the directory with the git index
that `./script/init-local-index.sh` set up.

Note that when you're running crates.io in development mode without the S3
Expand All @@ -478,7 +478,7 @@ content:
[source]

[source.mirror]
registry = "file:///path/to/your/crates.io/checkout/tmp/index-co"
registry = "file:///path/to/your/crates.io/tmp/index-bare"

[source.crates-io]
replace-with = "mirror"
Expand All @@ -488,8 +488,8 @@ Then add the crate you published to your local crates.io as a dependency in
this crate's `Cargo.toml`, and `cargo build` should display output like this:

```
Updating registry `file:///path/to/your/crates.io/checkout/tmp/index-co`
Downloading yourcrate v0.1.0 (registry file:///path/to/your/crates.io/checkout/tmp/index-co)
Updating registry `file:///path/to/your/crates.io/tmp/index-bare`
Downloading yourcrate v0.1.0 (registry file:///path/to/your/crates.io/tmp/index-bare)
Compiling yourcrate v0.1.0
Compiling thiscrate v0.1.0 (file:///path/to/thiscrate)
Finished dev [unoptimized + debuginfo] target(s) in 0.56 secs
Expand Down
2 changes: 1 addition & 1 deletion script/init-local-index.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,5 @@ touch tmp/index-bare/git-daemon-export-ok
cat - <<-EOF
Your local git index is ready to go!

Please refer to https://github.com/rust-lang/crates.io/blob/master/README.md for more info!
Please refer to https://github.com/rust-lang/crates.io/blob/master/docs/CONTRIBUTING.md for more info!
EOF