mirrors/jj
1
0
Fork 1
mirror of https://github.com/martinvonz/jj.git synced 2025-01-12 07:14:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

docs: goodbye Github, hello GitHub

Browse source
This commit is contained in:
Ilya Grigoriev 2023-08-28 10:30:33 -07:00 committed by Martin von Zweigbergk
parent c8bb8fbeb2
commit b67c115c29
3 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/contributing.md
View file

@ -114,7 +114,7 @@ These are listed roughly in order of decreasing importance.
The `--workspace` flag is needed to run the tests on all crates; by default, The `--workspace` flag is needed to run the tests on all crates; by default,
only the crate in the current directory is tested. only the crate in the current directory is tested.
2. Github CI checks require that the code is formatted with the *nightly* 2. GitHub CI checks require that the code is formatted with the *nightly*
version of `rustfmt`. To do this on your computer, install the nightly version of `rustfmt`. To do this on your computer, install the nightly
toolchain and use `cargo +nightly fmt`. toolchain and use `cargo +nightly fmt`.
@ -214,10 +214,10 @@ pure Git repo if you prefer.
2. Make sure `jjfan.github.com/jj` includes the `gh-pages` branch of the jj repo 2. Make sure `jjfan.github.com/jj` includes the `gh-pages` branch of the jj repo
and run `git fetch origin gh-pages`. and run `git fetch origin gh-pages`.
3. Go to the Github repository settings, enable Github Pages, and configure them 3. Go to the GitHub repository settings, enable GitHub Pages, and configure them
to use the `gh-pages` branch (this is usually the default). to use the `gh-pages` branch (this is usually the default).
4. Run the same `sh` script that is used in Github CI (details below): 4. Run the same `sh` script that is used in GitHub CI (details below):
```shell ```shell
.github/scripts/docs-build-deploy 'https://jjfan.github.io/jj/'\ .github/scripts/docs-build-deploy 'https://jjfan.github.io/jj/'\
@ -294,4 +294,4 @@ you can submit a PR based on the `gh-pages` branch of
[library docs]: https://docs.rs/prost-build/latest/prost_build/#sourcing-protoc [library docs]: https://docs.rs/prost-build/latest/prost_build/#sourcing-protoc
The `.rs` files generated from `.proto` files are included in the repository, The `.rs` files generated from `.proto` files are included in the repository,
and there is a Github CI check that will complain if they do not match. and there is a GitHub CI check that will complain if they do not match.

2
docs/github.md
View file

@ -4,7 +4,7 @@ This guide assumes a basic understanding of either Git or Mercurial.
## Set up an SSH key ## Set up an SSH key
As of December 2022 it's recommended to set up an SSH key to work with Github As of December 2022 it's recommended to set up an SSH key to work with GitHub
projects. See [GitHub's Tutorial][gh]. This restriction may be lifted in the projects. See [GitHub's Tutorial][gh]. This restriction may be lifted in the
future, see [issue #469][http-auth] for more information and progress on future, see [issue #469][http-auth] for more information and progress on
authenticated http. authenticated http.

2
mkdocs.yml
View file

@ -41,7 +41,7 @@ nav:
- 'Getting started': - 'Getting started':
- 'Installation and Setup': 'install-and-setup.md' - 'Installation and Setup': 'install-and-setup.md'
- 'Tutorial and Birds-Eye View': 'tutorial.md' - 'Tutorial and Birds-Eye View': 'tutorial.md'
- 'Working with Github': 'github.md' - 'Working with GitHub': 'github.md'
- FAQ: 'FAQ.md' - FAQ: 'FAQ.md'