From 51cbf4bae364f71bcf77f47ce1b51a71bcfb3e85 Mon Sep 17 00:00:00 2001 From: Ohad Dahan Date: Sat, 15 Aug 2020 16:26:47 +0300 Subject: [PATCH 1/3] Fix README --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8f6155ec7..0792e63e8 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,8 @@ git clone https://github.com/rust-lang/docs.rs.git docs.rs cd docs.rs # Configure the default settings for external services cp .env.sample .env +# Create the CRATESFYI_PREFIX directory +mkdir -p ignored/cratesfyi-prefix/crates.io-index # Builds the docs.rs binary cargo build # Start the extenal services @@ -53,7 +55,7 @@ docker-compose up -d db s3 # Build a sample crate to make sure it works # This sets up the docs.rs build environment, including installing the nightly # Rust toolchain. This will take a while the first time but will be cached afterwards. -cargo run web build crate regex 1.3.1 +cargo run build crate regex 1.3.1 # This starts the web server but does not build any crates. cargo run start-web-server ``` From 34e13556abf8a8f14d99605452c24ac5ce987bac Mon Sep 17 00:00:00 2001 From: Ohad Dahan Date: Sat, 15 Aug 2020 17:07:09 +0300 Subject: [PATCH 2/3] Fix README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0792e63e8..e719e583b 100644 --- a/README.md +++ b/README.md @@ -160,13 +160,13 @@ cargo run -- build crate --local /path/to/source ```sh # Adds a directory into database to serve with `staticfile` crate. -docker-compose run web database add-directory [PREFIX] +docker-compose run -- database add-directory [PREFIX] # Updates github stats for crates. # You need to set CRATESFYI_GITHUB_USERNAME, CRATESFYI_GITHUB_ACCESSTOKEN # environment variables in order to run this command. # You can set this environment variables in ~/.cratesfyi.env file. -docker-compose run web database update-github-fields +docker-compose run -- database update-github-fields ``` If you want to explore or edit database manually, you can connect to the database From 18335b02b3370ced9653ea9fc43b45c26141238b Mon Sep 17 00:00:00 2001 From: ohaddahan Date: Sat, 15 Aug 2020 17:23:55 +0300 Subject: [PATCH 3/3] Update README.md Co-authored-by: Joshua Nelson --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e719e583b..3fb1ce37d 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ docker-compose up -d db s3 # Build a sample crate to make sure it works # This sets up the docs.rs build environment, including installing the nightly # Rust toolchain. This will take a while the first time but will be cached afterwards. -cargo run build crate regex 1.3.1 +cargo run -- build crate regex 1.3.1 # This starts the web server but does not build any crates. cargo run start-web-server ```