diff --git a/.github/workflows/installation-script.yml b/.github/workflows/installation-script.yml index b0b8a2b25..4f90dc118 100644 --- a/.github/workflows/installation-script.yml +++ b/.github/workflows/installation-script.yml @@ -30,7 +30,7 @@ jobs: src: - 'docs/src/install.sh' - 'docs/src/install.ps1' - - 'docs/src/getting_started/installation.md' + - 'docs/src/getting-started/installation.md' - '.github/workflows/installation-script.yml' - id: decisions run: | diff --git a/README.md b/README.md index 873259812..90ff1c450 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Sysand client usage documentation is provided in User Guide at ## Installation -See [installation section in User Guide](http://client.sysand.com/getting_started/installation.html) +See [installation section in User Guide](http://client.sysand.com/getting-started/installation.html) for various ways to download Sysand. ## Contributing diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 24c06a0da..2d47a596b 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -1,8 +1,8 @@ # Summary -- [Getting started](getting_started.md) - - [Installation](getting_started/installation.md) - - [Tutorial](getting_started/tutorial.md) +- [Getting started](getting-started.md) + - [Installation](getting-started/installation.md) + - [Tutorial](getting-started/tutorial.md) - [Project metadata](metadata.md) - [Authentication](authentication.md) - [Workspaces](workspaces.md) @@ -44,7 +44,7 @@ - [sysand info created](commands/info/created.md) - [sysand sources](commands/sources.md) - [sysand print-root](commands/root.md) -- [Self-hosting a project index](hosting_index.md) +- [Self-hosting a project index](hosting-index.md) - [Publishing a package to Sysand Package Index](publishing.md) - [Configuration](config.md) - [Indexes](config/indexes.md) diff --git a/docs/src/commands/index.md b/docs/src/commands/index.md index c54dcce07..095492be5 100644 --- a/docs/src/commands/index.md +++ b/docs/src/commands/index.md @@ -1,6 +1,6 @@ # `sysand index` -Manage a local sysand index. See guide [Hosting Index](../hosting_index.md). +Manage a local sysand index. See guide [Hosting Index](../hosting-index.md). ## Usage diff --git a/docs/src/getting_started.md b/docs/src/getting-started.md similarity index 83% rename from docs/src/getting_started.md rename to docs/src/getting-started.md index 0f51af96d..f747763d1 100644 --- a/docs/src/getting_started.md +++ b/docs/src/getting-started.md @@ -3,8 +3,8 @@ To get started with Sysand, first follow the instructions for installing Sysand, then try out the steps in the tutorial. -- [Installation](getting_started/installation.md) -- [Tutorial](getting_started/tutorial.md) +- [Installation](getting-started/installation.md) +- [Tutorial](getting-started/tutorial.md) Some useful resources related to Sysand: diff --git a/docs/src/getting_started/installation.md b/docs/src/getting-started/installation.md similarity index 100% rename from docs/src/getting_started/installation.md rename to docs/src/getting-started/installation.md diff --git a/docs/src/getting_started/tutorial.md b/docs/src/getting-started/tutorial.md similarity index 100% rename from docs/src/getting_started/tutorial.md rename to docs/src/getting-started/tutorial.md diff --git a/docs/src/hosting_index.md b/docs/src/hosting-index.md similarity index 100% rename from docs/src/hosting_index.md rename to docs/src/hosting-index.md