Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit d518b05

Browse files
Move dev/ docs to development/ (#10453)
1 parent 5e2df47 commit d518b05

File tree

9 files changed

+8
-7
lines changed

9 files changed

+8
-7
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,7 @@ By now, you know the drill!
392392
# Notes for maintainers on merging PRs etc
393393

394394
There are some notes for those with commit access to the project on how we
395-
manage git [here](docs/dev/git.md).
395+
manage git [here](docs/development/git.md).
396396

397397
# Conclusion
398398

changelog.d/10453.doc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Consolidate development documentation to `docs/development/`.

docs/SUMMARY.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
# Development
6868
- [Contributing Guide](development/contributing_guide.md)
6969
- [Code Style](code_style.md)
70-
- [Git Usage](dev/git.md)
70+
- [Git Usage](development/git.md)
7171
- [Testing]()
7272
- [OpenTracing](opentracing.md)
7373
- [Database Schemas](development/database_schema.md)
@@ -77,8 +77,8 @@
7777
- [TCP Replication](tcp_replication.md)
7878
- [Internal Documentation](development/internal_documentation/README.md)
7979
- [Single Sign-On]()
80-
- [SAML](dev/saml.md)
81-
- [CAS](dev/cas.md)
80+
- [SAML](development/saml.md)
81+
- [CAS](development/cas.md)
8282
- [State Resolution]()
8383
- [The Auth Chain Difference Algorithm](auth_chain_difference_algorithm.md)
8484
- [Media Repository](media_repository.md)
File renamed without changes.

docs/dev/git.md docs/development/git.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ commits each of which contains a single change building on what came
99
before. Here, by way of an arbitrary example, is the top of `git log --graph
1010
b2dba0607`:
1111

12-
<img src="git/clean.png" alt="clean git graph" width="500px">
12+
<img src="img/git/clean.png" alt="clean git graph" width="500px">
1313

1414
Note how the commit comment explains clearly what is changing and why. Also
1515
note the *absence* of merge commits, as well as the absence of commits called
@@ -61,7 +61,7 @@ Ok, so that's what we'd like to achieve. How do we achieve it?
6161
The TL;DR is: when you come to merge a pull request, you *probably* want to
6262
“squash and merge”:
6363

64-
![squash and merge](git/squash.png).
64+
![squash and merge](img/git/squash.png).
6565

6666
(This applies whether you are merging your own PR, or that of another
6767
contributor.)
@@ -105,7 +105,7 @@ complicated. Here's how we do it.
105105

106106
Let's start with a picture:
107107

108-
![branching model](git/branches.jpg)
108+
![branching model](img/git/branches.jpg)
109109

110110
It looks complicated, but it's really not. There's one basic rule: *anyone* is
111111
free to merge from *any* more-stable branch to *any* less-stable branch at
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)