Skip to content

Commit d89a96a

Browse files
committed
Moved Rust Forge content to mdbook
1 parent 8dfcbd7 commit d89a96a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+485
-2590
lines changed

.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
src/compiler/profile-queries/* linguist-documentation
2+

.gitignore

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1 @@
1-
*~
2-
_site/
3-
target/
4-
vendor/
5-
_config.yml
1+
book

.travis.yml

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ language: rust
22
dist: xenial
33

44
env:
5-
RUSTINFRA_DEPLOY_DIR: _site
5+
RUSTINFRA_DEPLOY_DIR: book
66
RUSTINFRA_CLOUDFRONT_DISTRIBUTION: E12A3GKHZSREHP
77
import:
88
- rust-lang/simpleinfra/travis-configs/static-websites.yml
@@ -12,14 +12,13 @@ cache:
1212
# cache: cargo
1313
- $HOME/.cargo
1414
- $TRAVIS_BUILD_DIR/target
15-
# cache: bundler
16-
- $TRAVIS_BUILD_DIR/vendor/bundle
17-
18-
install:
19-
- bundle install --path vendor/bundle
2015

16+
before_script:
17+
# TODO: Installing mdbook from crates.io takes quite a long time. This could
18+
# be reduced by downloading the release from GitHub directly.
19+
- cargo install mdbook --vers '^0.3.0' --force
2120
script:
22-
- cargo run && bundle exec jekyll build
21+
- mdbook build
2322
branches:
2423
only:
2524
- master

Gemfile

Lines changed: 0 additions & 3 deletions
This file was deleted.

Gemfile.lock

Lines changed: 0 additions & 248 deletions
This file was deleted.

README.md

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,20 @@
1-
# [Rust Forge](https://forge.rust-lang.org)
1+
# Rust Forge
22

3-
This site contains supplementary documentation useful to the members of
4-
[The Rust Project](https://www.rust-lang.org). To edit it submit PR's against
5-
[rust-lang/rust-forge].
3+
Welcome to the [Rust Forge]! Rust Forge serves as a repository of supplementary
4+
documentation useful for members of [The Rust Programming Language].
65

7-
[rust-lang/rust-forge]: https://github.com/rust-lang/rust-forge
6+
# Building
7+
```
8+
$ mdbook build
9+
```
810

9-
<hr/>
11+
# Development
12+
When developing it's recommended to use the `serve` command to launch a local
13+
server to allow you to easily see and update changes you make.
14+
```
15+
$ mdbook serve
16+
```
1017

11-
- [Release history](releases.md). Links to previous release artifacts.
18+
[The Rust Programming Language]: https://rust-lang.org
19+
[Rust Forge]: forge.rust-lang.org
1220

13-
- [Platform support](platform-support.md).
14-
15-
- [Friend of the Tree archives](fott.md).
16-
17-
- [Bibliography](bibliography.md). Research papers and other links to projects
18-
that influenced Rust. Papers about Rust.
19-
20-
- [Release process](release-process.md). How to make releases of Rust.
21-
22-
- [The Rust test suite](test-suite.md).
23-
24-
- [Bots, websites and infrastructure](infrastructure.md). A catalog of the IRC
25-
bots, websites and other infrastructure used by the project, what they do, and
26-
who maintains them (i.e. who to contact when they malfunction and go on a bot
27-
rampage).

_layouts/default.html

Lines changed: 0 additions & 38 deletions
This file was deleted.

bibliography.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

book.toml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
[book]
2+
authors = ["The Rust Programming Language Team & Community"]
3+
description = "Supplemental documentation for contributing to The Rust Programming Language"
4+
language = "en"
5+
multilingual = false
6+
src = "src"
7+
title = "Rust Forge"
8+
9+
[output.html]
10+
additional-js = ["js/moment.min.js", "js/index.js"]
11+
no-section-label=true
12+
git-repository-url="https://github.com/rust-lang/rust-forge"

0 commit comments

Comments
 (0)