Skip to content

Commit

Permalink
doc: Update gitoxide repository URLs
Browse files Browse the repository at this point in the history
This updates `Byron/gitoxide` URLs to `GitoxideLabs/gitoxide` in:

- Markdown documentation, except changelogs and other such files
  where such changes should not be made.

- Documentation comments (in .rs files).

- Manifest (.toml) files, for the value of the `repository` key.

- The comments appearing at the top of a sample hook that contains
  a repository URL as an example.

When making these changes, I also allowed my editor to remove
trailing whitespace in any lines in files already being edited
(since, in this case, there was no disadvantage to allowing this).

The gitoxide repository URL changed when the repository was moved
into the recently created GitHub organization `GitoxideLabs`, as
detailed in #1406. Please note that, although I believe updating
the URLs to their new canonical values is useful, this is not
needed to fix any broken links, since `Byron/gitoxide` URLs
redirect (and hopefully will always redirect) to the coresponding
`GitoxideLabs/gitoxide` URLs.

While this change should not break any URLs, some affected URLs
were already broken. This updates them, but they are still broken.
They will be fixed in a subsequent commit.

This also does not update `Byron/gitoxide` URLs in test fixtures
or test cases, nor in the `Makefile`. (It may make sense to change
some of those too, but it is not really a documentation change.)
  • Loading branch information
EliahKagan committed Oct 14, 2024
1 parent 70c4df5 commit 64ff0a7
Show file tree
Hide file tree
Showing 95 changed files with 273 additions and 274 deletions.
9 changes: 4 additions & 5 deletions COLLABORATING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
- If you're unsure about remembering to do this, we suggest using a pre-commit git hook.
- **if `main` breaks on CI** _which can happen nonetheless_
- …and you _do know_ the cause, please fix it immediately. If necessary by reverting the offending commit until a more durable fix is possible.
- …and you _do not know_ the cause, please open a PR to invite collaborators for their input. This is to avoid multiple collaborators
- …and you _do not know_ the cause, please open a PR to invite collaborators for their input. This is to avoid multiple collaborators
trying to fix the issue independently, causing merge-conflicts and confusion. We use this PR as synchronization primitive.
- **for crates _you own_**
- feel free to make any kind of changes to it, including major ones.
Expand All @@ -29,7 +29,6 @@ The workflow can be changed after public discussion - to get started, open a PR.

Please see the [development guide] for more detailed information on how code and cargo manifests are structured.

[development guide]: https://github.com/Byron/gitoxide/blob/main/DEVELOPMENT.md
[project-board]: https://github.com/Byron/gitoxide/projects
[discussions]: https://github.com/Byron/gitoxide/discussions

[development guide]: https://github.com/GitoxideLabs/gitoxide/blob/main/DEVELOPMENT.md
[project-board]: https://github.com/GitoxideLabs/gitoxide/projects
[discussions]: https://github.com/GitoxideLabs/gitoxide/discussions
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
For now, please have a look at the section in the [README] file.

[README]: https://github.com/Byron/gitoxide#contributions
[README]: https://github.com/GitoxideLabs/gitoxide#contributions
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ lints.workspace = true
[package]
name = "gitoxide"
description = "A command-line application for interacting with git repositories"
repository = "https://github.com/Byron/gitoxide"
repository = "https://github.com/GitoxideLabs/gitoxide"
authors = ["Sebastian Thiel <[email protected]>"]
edition = "2021"
license = "MIT OR Apache-2.0"
Expand Down Expand Up @@ -392,4 +392,4 @@ unnecessary_join = "allow" # x1
stable_sort_primitive = "allow" # x1
no_effect_underscore_binding = "allow" # x1
empty_docs = "allow"
too_long_first_doc_paragraph = "allow"
too_long_first_doc_paragraph = "allow"
4 changes: 2 additions & 2 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* handle all errors, never `unwrap()`. If needed, `expect("why")`.
* provide an error chain and make it easy to understand what went wrong.
* We `thiserror` generally.
* Adhere to the [stability guide](https://github.com/Byron/gitoxide/blob/main/STABILITY.md)
* Adhere to the [stability guide](https://github.com/GitoxideLabs/gitoxide/blob/main/STABILITY.md)

## Commit Messages

Expand Down Expand Up @@ -196,7 +196,7 @@ In _porcelain_ crates, like `gix`, we have `Platforms` which are typically cheap
should keep a reference to the `Repository` instance that created them as the user is expected to clone the `Repository` if there is the need.
However, if these structures are more expensive, call them `Cache` or `<NotPlatform>` and prefer to clone the `Repository` into them or otherwise keep them free of lifetimes
to allow the user to keep this structure around for repeated calls. References for this paragraph are [this PR](https://github.com/Canop/bacon/pull/98) and
[this discussion](https://github.com/Byron/gitoxide/discussions/675).
[this discussion](https://github.com/GitoxideLabs/gitoxide/discussions/675).

## Examples, Porcelain CLI and Plumbing CLI - which does what?

Expand Down
168 changes: 84 additions & 84 deletions README.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

## Reporting a Vulnerability

Please feel free to [draft a GitHub advisory](https://github.com/Byron/gitoxide/security/advisories/new), and I will work with you to disclose and or resolve the issue
Please feel free to [draft a GitHub advisory](https://github.com/GitoxideLabs/gitoxide/security/advisories/new), and I will work with you to disclose and or resolve the issue
responsibly.

If this doesn't seem like the right approach or there are questions, please feel free to reach out to the @icloud.com email used in my commits.
If this doesn't seem like the right approach or there are questions, please feel free to reach out to the @icloud.com email used in my commits.

Thank you.
4 changes: 2 additions & 2 deletions SHORTCOMINGS.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This file is for tracking features that are less well implemented or less powerf
* **Objects larger than 32 bits cannot be loaded on 32 bit systems**
* in-memory representations objects cannot handle objects greater than the amount of addressable memory.
* This will not affect git LFS though.

### `gix`

* object replacements are read once upon opening the repository from their refs and changes to these won't be picked up.
Expand All @@ -38,5 +38,5 @@ This file is for tracking features that are less well implemented or less powerf

### `gix-features`

* **sha1** isn't hardened (i.e. doesn't have collision detection). Needs [to be contributed](https://github.com/Byron/gitoxide/issues/585).
* **sha1** isn't hardened (i.e. doesn't have collision detection). Needs [to be contributed](https://github.com/GitoxideLabs/gitoxide/issues/585).
* **local time** is currently impeded by [this issue](https://github.com/time-rs/time/issues/293#issuecomment-909158529) but it's planned to resolve it eventually.
72 changes: 36 additions & 36 deletions STABILITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,55 +34,55 @@ our [collaboration guide].
The following schematic helps to visualize what follows.

```text
Release Software v1.X
Stability Tier 1 ═════════════════════════════╗
║ ║
║ gix──────────────┐ ein──────────────┐ ║
║ │ plumbing app │ │ porcelain app │ ║
║ └────────────────┘ └────────────────┘ ║
║ │ │ ║
║ ▼ ▼ ║
║ gitoxide-core───────────────────────┐ ║
║ │ application functionality │ ║
║ └───────────────────────────────────┘ ║
║ │ ║
║ ▼ ║
║ gix ──────────────────────────────┐ ║
║ │ application crate │─ ─ ╬ ─
Release Software v1.X
Stability Tier 1 ═════════════════════════════╗
║ ║
║ gix──────────────┐ ein──────────────┐ ║
║ │ plumbing app │ │ porcelain app │ ║
║ └────────────────┘ └────────────────┘ ║
║ │ │ ║
║ ▼ ▼ ║
║ gitoxide-core───────────────────────┐ ║
║ │ application functionality │ ║
║ └───────────────────────────────────┘ ║
║ │ ║
║ ▼ ║
║ gix ──────────────────────────────┐ ║
║ │ application crate │─ ─ ╬ ─
║ └───────────────────────────────────┘ ║ │
║ │ ║
║ │ ║
║ ▼ ║ │
║ Foundation Crates───────────────────┐ ║
║ Foundation Crates───────────────────┐ ║
║ │ ┌─────────────┐ ┌─────────────┐ │ ║ │
║ │ │ gix-hash │ │ gix-actor │ │ ║
║ │ │ gix-hash │ │ gix-actor │ │ ║
║ │ └─────────────┘ └─────────────┘ │ ║ │
║ │ ┌─────────────┐ ┌─────────────┐ │ ║
║ │ ┌─────────────┐ ┌─────────────┐ │ ║
║ │ │ gix-ref │ │ gix-config │ │ ║ │
║ │ └─────────────┘ └─────────────┘ │ ║
║ │ └─────────────┘ └─────────────┘ │ ║
║ │ ┌─────────────┐ ┌─────────────┐ │ ║ │
║ │ │ gix-object │ │ gix-lock │ │ ║
║ │ │ gix-object │ │ gix-lock │ │ ║
║ │ └─────────────┘ └─────────────┘ │ ║ │
║ │ ┌───────────────────────────────┐ │ ║
║ │ ┌───────────────────────────────┐ │ ║
║ │ │ gix-features │ │ ║ │
║ │ └───────────────────────────────┘ │ ║
║ │ └───────────────────────────────┘ │ ║
║ └───────────────────────────────────┘ ║ │
║ ║
║ ║
╚═════════════════════════════════════════════╝ │
Stability Tier 2 ─────────────────────────────┐ │
│ │
│ │
│ Plumbing Crates─────────────────────┐ │ │
│ │ ┌─────────────┐ ┌─────────────┐ │ │
│ │ ┌─────────────┐ ┌─────────────┐ │ │
│ │ │ gix-odb │ │ gix-diff │ │ │ │
│ │ └─────────────┘ └─────────────┘ │ │
│ │ └─────────────┘ └─────────────┘ │ │
│ │ ┌─────────────┐ ┌─────────────┐ │ │ │
│ │ │gix-traverse │ │ gix-pack │ │◀ ─ ┼ ─
│ │ └─────────────┘ └─────────────┘ │ │
│ │ ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐ │ │
│ │ …many more… │ │
│ │ └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘ │ │
│ └───────────────────────────────────┘ │
│ │
│ │ │gix-traverse │ │ gix-pack │ │◀ ─ ┼ ─
│ │ └─────────────┘ └─────────────┘ │ │
│ │ ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐ │ │
│ │ …many more… │ │
│ │ └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘ │ │
│ └───────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────┘
```

Expand Down Expand Up @@ -151,4 +151,4 @@ Apps and application crates may take longer as they are larger in scope. A good
use. Their scope should also be narrowed to a minimal viable product.

[semver]: https://semver.org
[collaboration guide]: https://github.com/Byron/gitoxide/blob/main/COLLABORATING.md
[collaboration guide]: https://github.com/GitoxideLabs/gitoxide/blob/main/COLLABORATING.md
Loading

0 comments on commit 64ff0a7

Please sign in to comment.