diff options
author | Eric Eastwood <erice@element.io> | 2021-07-22 05:58:24 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-07-22 12:58:24 +0200 |
commit | d518b05a8667943bd0aa9ab1edc91eec0a8283fe (patch) | |
tree | 288f16d93e64d0d2ec3041b99861603af9a51ad0 | |
parent | Cancel redundant GHA workflows (#10451) (diff) | |
download | synapse-d518b05a8667943bd0aa9ab1edc91eec0a8283fe.tar.xz |
Move dev/ docs to development/ (#10453)
-rw-r--r-- | CONTRIBUTING.md | 2 | ||||
-rw-r--r-- | changelog.d/10453.doc | 1 | ||||
-rw-r--r-- | docs/SUMMARY.md | 6 | ||||
-rw-r--r-- | docs/development/cas.md (renamed from docs/dev/cas.md) | 0 | ||||
-rw-r--r-- | docs/development/git.md (renamed from docs/dev/git.md) | 6 | ||||
-rw-r--r-- | docs/development/img/git/branches.jpg (renamed from docs/dev/git/branches.jpg) | bin | 72228 -> 72228 bytes | |||
-rw-r--r-- | docs/development/img/git/clean.png (renamed from docs/dev/git/clean.png) | bin | 110840 -> 110840 bytes | |||
-rw-r--r-- | docs/development/img/git/squash.png (renamed from docs/dev/git/squash.png) | bin | 29667 -> 29667 bytes | |||
-rw-r--r-- | docs/development/saml.md (renamed from docs/dev/saml.md) | 0 |
9 files changed, 8 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a4e6688042..80ef6aa235 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -392,7 +392,7 @@ By now, you know the drill! # Notes for maintainers on merging PRs etc There are some notes for those with commit access to the project on how we -manage git [here](docs/dev/git.md). +manage git [here](docs/development/git.md). # Conclusion diff --git a/changelog.d/10453.doc b/changelog.d/10453.doc new file mode 100644 index 0000000000..5d4db9bca2 --- /dev/null +++ b/changelog.d/10453.doc @@ -0,0 +1 @@ +Consolidate development documentation to `docs/development/`. diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index db4ef1a44e..f1bde91420 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -67,7 +67,7 @@ # Development - [Contributing Guide](development/contributing_guide.md) - [Code Style](code_style.md) - - [Git Usage](dev/git.md) + - [Git Usage](development/git.md) - [Testing]() - [OpenTracing](opentracing.md) - [Database Schemas](development/database_schema.md) @@ -77,8 +77,8 @@ - [TCP Replication](tcp_replication.md) - [Internal Documentation](development/internal_documentation/README.md) - [Single Sign-On]() - - [SAML](dev/saml.md) - - [CAS](dev/cas.md) + - [SAML](development/saml.md) + - [CAS](development/cas.md) - [State Resolution]() - [The Auth Chain Difference Algorithm](auth_chain_difference_algorithm.md) - [Media Repository](media_repository.md) diff --git a/docs/dev/cas.md b/docs/development/cas.md index 592b2d8d4f..592b2d8d4f 100644 --- a/docs/dev/cas.md +++ b/docs/development/cas.md diff --git a/docs/dev/git.md b/docs/development/git.md index 87950f07b2..9b1ed54b65 100644 --- a/docs/dev/git.md +++ b/docs/development/git.md @@ -9,7 +9,7 @@ commits each of which contains a single change building on what came before. Here, by way of an arbitrary example, is the top of `git log --graph b2dba0607`: -<img src="git/clean.png" alt="clean git graph" width="500px"> +<img src="img/git/clean.png" alt="clean git graph" width="500px"> Note how the commit comment explains clearly what is changing and why. Also 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? The TL;DR is: when you come to merge a pull request, you *probably* want to “squash and merge”: -![squash and merge](git/squash.png). +![squash and merge](img/git/squash.png). (This applies whether you are merging your own PR, or that of another contributor.) @@ -105,7 +105,7 @@ complicated. Here's how we do it. Let's start with a picture: -![branching model](git/branches.jpg) +![branching model](img/git/branches.jpg) It looks complicated, but it's really not. There's one basic rule: *anyone* is free to merge from *any* more-stable branch to *any* less-stable branch at diff --git a/docs/dev/git/branches.jpg b/docs/development/img/git/branches.jpg index 715ecc8cd0..715ecc8cd0 100644 --- a/docs/dev/git/branches.jpg +++ b/docs/development/img/git/branches.jpg Binary files differdiff --git a/docs/dev/git/clean.png b/docs/development/img/git/clean.png index 3accd7ccef..3accd7ccef 100644 --- a/docs/dev/git/clean.png +++ b/docs/development/img/git/clean.png Binary files differdiff --git a/docs/dev/git/squash.png b/docs/development/img/git/squash.png index 234caca3e4..234caca3e4 100644 --- a/docs/dev/git/squash.png +++ b/docs/development/img/git/squash.png Binary files differdiff --git a/docs/dev/saml.md b/docs/development/saml.md index a9bfd2dc05..a9bfd2dc05 100644 --- a/docs/dev/saml.md +++ b/docs/development/saml.md |