Skip to content

Commit

Permalink
Update doc links (#2211)
Browse files Browse the repository at this point in the history
* Update to 3.85.1

* Update doc links

* Changelog

* Schema

* Revert mistake

* CR
  • Loading branch information
eyalb181 authored Jan 29, 2024
1 parent 3c4f4dc commit 3956cf6
Show file tree
Hide file tree
Showing 11 changed files with 14 additions and 13 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Container run inside the pod launched by mirrord requires additional [Linux capa
- `CAP_SYS_PTRACE` - for reading target pod environment
- `CAP_SYS_ADMIN` - for joining target pod network namespace

However, you can disable any subset of those in the [configuration](https://mirrord.dev/docs/overview/configuration/).
However, you can disable any subset of those in the [configuration](https://mirrord.dev/docs/reference/configuration/).
This will possibly limit mirrord functionalities or even make it unusable in some setups.

```bash
Expand All @@ -145,7 +145,7 @@ MIRRORD_AGENT_DISABLED_CAPABILITIES=CAP_NET_RAW,CAP_SYS_PTRACE mirrord exec node

## FAQ

Our FAQ is available [here](https://mirrord.dev/docs/overview/faq/).
Our FAQ is available [here](https://mirrord.dev/docs/faq/general/).
If you have a question that's not on there, feel free to ask in our [Discussions](https://github.com/metalbear-co/mirrord/discussions)
or on [Discord](https://discord.gg/metalbear).

Expand Down
1 change: 1 addition & 0 deletions changelog.d/+update-docs-links.internal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update links to new docs
2 changes: 1 addition & 1 deletion medschool/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ It'll look into `rust-project/src` and produce `rust-project/configuration.md`.
## Usage

To generate the `configuration.md` that you see in the
[docs page](https://mirrord.dev/docs/overview/configuration/) we use the `medschool` tool as such:
[docs page](https://mirrord.dev/docs/reference/configuration/) we use the `medschool` tool as such:

```sh
cargo run -p medschool -- --input ./mirrord/config/src --output ./configuration.md
Expand Down
2 changes: 1 addition & 1 deletion mirrord-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -483,7 +483,7 @@
"properties": {
"copy_target": {
"title": "feature.copy_target {#feature-copy_target}",
"description": "Creates a new copy of the target. mirrord will use this copy instead of the original target (e.g. intercept network traffic). This feature requires a [mirrord operator](https://mirrord.dev/docs/teams/introduction/).\n\nThis feature is not compatible with rollout targets and running without a target (`targetless` mode).",
"description": "Creates a new copy of the target. mirrord will use this copy instead of the original target (e.g. intercept network traffic). This feature requires a [mirrord operator](https://mirrord.dev/docs/overview/teams/).\n\nThis feature is not compatible with rollout targets and running without a target (`targetless` mode).",
"anyOf": [
{
"$ref": "#/definitions/CopyTargetFileConfig"
Expand Down
2 changes: 1 addition & 1 deletion mirrord/cli/src/connection.rs
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ where
// This is CLI Only because the extensions also implement this check with better messaging.
progress.print( "When targeting multi-pod deployments, mirrord impersonates the first pod in the deployment.");
progress.print("Support for multi-pod impersonation requires the mirrord operator, which is part of mirrord for Teams.");
progress.print("You can get started with mirrord for Teams at this link: https://mirrord.dev/docs/teams/introduction/");
progress.print("You can get started with mirrord for Teams at this link: https://mirrord.dev/docs/overview/teams/");
}

let k8s_api = KubernetesAPI::create(config)
Expand Down
6 changes: 3 additions & 3 deletions mirrord/cli/src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ pub(crate) enum CliError {
"operator": false
}}
Please remember that some features are supported only when using mirrord operator (https://mirrord.dev/docs/teams/introduction/#supported-features).
Please remember that some features are supported only when using mirrord operator (https://mirrord.dev/docs/overview/teams/#supported-features).
{GENERAL_HELP}"#
))]
OperatorConnectionFailed(String),
Expand All @@ -75,7 +75,7 @@ pub(crate) enum CliError {
}}
}}
More info (https://mirrord.dev/docs/overview/configuration/#feature-network-incoming-on_concurrent_steal)
More info (https://mirrord.dev/docs/reference/configuration/#feature-network-incoming-on_concurrent_steal)
{GENERAL_HELP}"#
))]
Expand Down Expand Up @@ -237,7 +237,7 @@ pub(crate) enum CliError {
InternalProxyError(#[from] IntProxyError),
#[error("Feature `{0}` requires a mirrord operator.")]
#[diagnostic(help(
"The mirrord operator is part of mirrord for Teams. You can get started with mirrord for Teams at this link: https://mirrord.dev/docs/teams/introduction/"
"The mirrord operator is part of mirrord for Teams. You can get started with mirrord for Teams at this link: https://mirrord.dev/docs/overview/teams/"
))]
FeatureRequiresOperatorError(String),
#[error("Feature `{feature}` is not supported in mirrord operator {operator_version}.")]
Expand Down
2 changes: 1 addition & 1 deletion mirrord/cli/src/teams.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use tokio::process::Command;

const MIRRORD_FOR_TEAMS_URL: &str = "https://mirrord.dev/docs/teams/introduction/";
const MIRRORD_FOR_TEAMS_URL: &str = "https://mirrord.dev/docs/overview/teams/";

#[cfg(not(target_os = "macos"))]
fn get_open_command() -> Command {
Expand Down
2 changes: 1 addition & 1 deletion mirrord/config/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -964,7 +964,7 @@ Valid values follow this pattern: `[protocol]://[name|address|subnet/mask]:[port
## feature.copy_target {#feature-copy_target}

Creates a new copy of the target. mirrord will use this copy instead of the original target
(e.g. intercept network traffic). This feature requires a [mirrord operator](https://mirrord.dev/docs/teams/introduction/).
(e.g. intercept network traffic). This feature requires a [mirrord operator](https://mirrord.dev/docs/overview/teams/).

This feature is not compatible with rollout targets and running without a target
(`targetless` mode).
Expand Down
2 changes: 1 addition & 1 deletion mirrord/config/src/feature.rs
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ pub struct FeatureConfig {
/// ## feature.copy_target {#feature-copy_target}
///
/// Creates a new copy of the target. mirrord will use this copy instead of the original target
/// (e.g. intercept network traffic). This feature requires a [mirrord operator](https://mirrord.dev/docs/teams/introduction/).
/// (e.g. intercept network traffic). This feature requires a [mirrord operator](https://mirrord.dev/docs/overview/teams/).
///
/// This feature is not compatible with rollout targets and running without a target
/// (`targetless` mode).
Expand Down
2 changes: 1 addition & 1 deletion mirrord/kube/src/api/kubernetes.rs
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ impl KubernetesAPI {
.await?
.has_group("route.openshift.io")
{
progress.warning("mirrord has detected it's running on OpenShift. Due to the default PSP of OpenShift, mirrord may not be able to create the agent. Please refer to the documentation at https://mirrord.dev/docs/overview/faq/#can-i-use-mirrord-with-openshift");
progress.warning("mirrord has detected it's running on OpenShift. Due to the default PSP of OpenShift, mirrord may not be able to create the agent. Please refer to the documentation at https://mirrord.dev/docs/faq/limitations/#does-mirrord-support-openshift");
} else {
debug!("OpenShift was not detected.");
}
Expand Down
2 changes: 1 addition & 1 deletion mirrord/layer/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
//!
//! The functions we intercept are controlled via the `mirrord-config` crate, check its
//! documentation for more details, or
//! [Configuration](https://mirrord.dev/docs/overview/configuration/) for usage information.
//! [Configuration](https://mirrord.dev/docs/reference/configuration/) for usage information.
extern crate alloc;
extern crate core;
Expand Down

0 comments on commit 3956cf6

Please sign in to comment.