Skip to content

Commit

Permalink
Do not manually copy READMEs to the developer site any longer
Browse files Browse the repository at this point in the history
  • Loading branch information
JoelMarcey authored and bors-libra committed Jan 5, 2021
1 parent 44e0fd7 commit 54508a7
Show file tree
Hide file tree
Showing 4 changed files with 2 additions and 37 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ cargo xtest
#### Code Style, Hints, and Testing

Refer to our [Coding
Guidelines](https://developers.diem.com/docs/community/coding-guidelines) for
Guidelines](https://github.com/diem/diem/blob/master/documentation/coding_guidelines.md) for
detailed guidance about how to contribute to the project.

#### Documentation
Expand Down
2 changes: 1 addition & 1 deletion common/logger/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
//! A set of logging macros (`info!`, `error!`, `warn!`, `debug!`, and `trace!`) is provided for
//! emitting logs at different levels. All of these macros support the addition of providing
//! structured data along with a formatted text message. For guidelines on which level to use,
//! see the [coding guidelines](https://developers.diem.com/docs/community/coding-guidelines#logging).
//! see the [coding guidelines](https://developers.diem.com/docs/core/coding-guidelines#logging).
//!
//! The below examples do no type checking for structured log fields, and instead just serialize
//! whatever is given.
Expand Down
3 changes: 0 additions & 3 deletions developers.diem.com/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,5 @@ node_modules/

# ignore autogenerated docs
diem
docs/crates/*
docs/community/coding-guidelines.md
docs/community/contributing.md
static/docs/rustdocs/
static/docs/python-client-sdk-docs/
32 changes: 0 additions & 32 deletions developers.diem.com/scripts/build_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -81,38 +81,6 @@ done
# Install Rust (Netlify will need this for website previews, for example)
install_rustup

# create needed output directories, ignore error if they exist already
mkdir -p docs/crates
mkdir -p docs/community

# manually copy crate README files from fixed directory
###
echo "-----------------------------------"
echo "Manually Copying READMEs to docs/crates"
echo "-----------------------------------"
sed -i.old '/^# /d' ../language/bytecode-verifier/README.md; cp ../language/bytecode-verifier/README.md docs/crates/bytecode-verifier.md
sed -i.old '/^# /d' ../consensus/README.md; cp ../consensus/README.md docs/crates/consensus.md
sed -i.old '/^# /d' ../crypto/crypto/README.md; cp ../crypto/crypto/README.md docs/crates/crypto.md
sed -i.old '/^# /d' ../execution/README.md; cp ../execution/README.md docs/crates/execution.md
sed -i.old '/^# /d' ../language/README.md; cp ../language/README.md docs/crates/move-language.md
sed -i.old '/^# /d' ../language/compiler/README.md; cp ../language/compiler/README.md docs/crates/ir-to-bytecode.md
sed -i.old '/^# /d' ../mempool/README.md; cp ../mempool/README.md docs/crates/mempool.md
sed -i.old '/^# /d' ../network/README.md; cp ../network/README.md docs/crates/network.md
sed -i.old '/^# /d' ../storage/README.md; cp ../storage/README.md docs/crates/storage.md
sed -i.old '/^# /d' ../language/vm/README.md; cp ../language/vm/README.md docs/crates/vm.md

echo "-----------------------------------"
echo "Manually Copy Coding Guidelines"
echo "-----------------------------------"
sed -i.old '/^# Diem Core Coding Guidelines/d' ../documentation/coding_guidelines.md
cp ../documentation/coding_guidelines.md docs/community/coding-guidelines.md

echo "-----------------------------------"
echo "Manually Copy Contributing Guidelines"
echo "-----------------------------------"
sed -i.old '/^# Diem Core Contributing Guidelines/d' ../CONTRIBUTING.md
cp ../CONTRIBUTING.md docs/community/contributing.md

if [[ $BUILD_RUSTDOCS == true ]]; then
echo "-----------------------------------"
echo "Generating API reference via Rustdoc"
Expand Down

0 comments on commit 54508a7

Please sign in to comment.