fix(docs): filename, header and title mismatch fixes (kanidm#2660)

Water261 · Mar 20, 2024 · 4849d98 · 4849d98
1 parent fcc65e6
commit 4849d98
Show file tree

Hide file tree

Showing 36 changed files with 48 additions and 48 deletions.
diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md
@@ -1,51 +1,51 @@
 # Kanidm
 
-- [Introduction to Kanidm](intro.md)
+- [Introduction to Kanidm](introduction_to_kanidm.md)
 
-- [Evaluation Quickstart](quickstart.md)
+- [Evaluation Quickstart](evaluation_quickstart.md)
 
-- [Supported Features](features.md)
+- [Supported Features](supported_features.md)
 - [Project Support](support.md)
 
 - [Installing the Server](installing_the_server.md)
   - [Choosing a Domain Name](choosing_a_domain_name.md)
-  - [Preparing for your Deployment](prepare_the_server.md)
-  - [Server Configuration and Install](server_configuration.md)
-  - [Platform Security Hardening](security_hardening.md)
-  - [Server Updates](server_update.md)
+  - [Preparing for your Deployment](preparing_for_your_deployment.md)
+  - [Server Configuration](server_configuration.md)
+  - [Security Hardening](security_hardening.md)
+  - [Server Updates](server_updates.md)
 
 - [Client Tools](client_tools.md)
-  - [Installing client tools](installing_client_tools.md)
+  - [Installing Client Tools](installing_client_tools.md)
 
-- [Administration](administrivia.md)
-  - [Backup and Restore](backup_restore.md)
-  - [Database Maintenance](database_maint.md)
+- [Administration](administration.md)
+  - [Backup and Restore](backup_and_restore.md)
+  - [Database Maintenance](database_maintenance.md)
   - [Domain Rename](domain_rename.md)
-  - [Monitoring the platform](monitoring.md)
-  - [The Recycle Bin](recycle_bin.md)
+  - [Monitoring the platform](monitoring_the_platform.md)
+  - [Recycle Bin](recycle_bin.md)
 
 - [Accounts and Groups](accounts/intro.md)
-  - [People Accounts](accounts/people.md)
-  - [Authentication and Credentials](accounts/authentication.md)
+  - [People Accounts](accounts/people_accounts.md)
+  - [Authentication and Credentials](accounts/authentication_and_credentials.md)
   - [Groups](accounts/groups.md)
-  - [Service Accounts](accounts/service.md)
-  - [Anonymous](accounts/anonymous.md)
-  - [Account Policy](accounts/policy.md)
-  - [POSIX Accounts and Groups](accounts/posix.md)
+  - [Service Accounts](accounts/service_accounts.md)
+  - [Anonymous Account](accounts/anonymous_account.md)
+  - [Account Policy](accounts/account_policy.md)
+  - [POSIX Accounts and Groups](accounts/posix_accounts_and_groups.md)
 
 - [Service Integrations](integrations/readme.md)
   - [PAM and nsswitch](integrations/pam_and_nsswitch.md)
     - [SUSE / OpenSUSE](integrations/pam_and_nsswitch/suse.md)
     - [Fedora](integrations/pam_and_nsswitch/fedora.md)
     - [Troubleshooting](integrations/pam_and_nsswitch/troubleshooting.md)
   - [SSSD](integrations/sssd.md)
-  - [SSH Key Distribution](integrations/ssh_key_dist.md)
+  - [SSH Key Distribution](integrations/ssh_key_distribution.md)
   - [Oauth2](integrations/oauth2.md)
   - [LDAP](integrations/ldap.md)
   - [RADIUS](integrations/radius.md)
 
 - [Service Integration Examples](examples/readme.md)
-  - [Kubernetes Ingress](examples/k8s_ingress_example.md)
+  - [Kubernetes Ingress](examples/kubernetes_ingress.md)
   - [Traefik](examples/traefik.md)
 
 - [Replication](repl/readme.md)
@@ -63,28 +63,28 @@
 
 - [Troubleshooting](troubleshooting.md)
 - [Frequently Asked Questions](frequently_asked_questions.md)
-- [Glossary of Technical Terms](glossary.md)
+- [Glossary](glossary.md)
 
 # For Developers
 
 - [Developer Guide](developers/readme.md)
-- [Developer Ethics](developers/ethics.md)
+- [Developer Ethics](developers/developer_ethics.md)
 - [Frequently Asked Questions](developers/faq.md)
 - [Design Documents]()
   - [Access Profiles 2022](developers/designs/access_profiles_rework_2022.md)
-  - [Access Profiles Original](developers/designs/access_profiles_and_security.md)
+  - [Access Profiles Original](developers/designs/access_profiles_original.md)
   - [Access Control Defaults](developers/designs/access_control_defaults.md)
   - [Architecture](developers/designs/architecture.md)
   - [Authentication flow](developers/designs/authentication_flow.md)
-  - [Cryptography Key Domains (2024)](developers/designs/cryptography-key-domains.md)
-  - [Domain Join](developers/designs/domain_join.md)
+  - [Cryptography Key Domains (2024)](developers/designs/cryptography_key_domains.md)
+  - [Domain Join - Machine Accounts](developers/designs/domain_join_machine_accounts.md)
   - [Elevated Priv Mode](developers/designs/elevated_priv_mode.md)
   - [Oauth2 Refresh Tokens](developers/designs/oauth2_refresh_tokens.md)
-  - [Replication Coordinator](developers/designs/replication_coord.md)
-  - [Replication Internals](developers/designs/replication.md)
+  - [Replication Coordinator](developers/designs/replication_coordinator.md)
+  - [Replication Design and Notes](developers/designs/replication_design_and_notes.md)
   - [REST Interface](developers/designs/rest_interface.md)
-- [Python Module](developers/python.md)
-- [RADIUS Integration](developers/radius.md)
+- [Python Module](developers/python_module.md)
+- [RADIUS Module Development](developers/radius.md)
 - [Release Checklist](developers/release_checklist.md)
 - [Packaging](developers/packaging.md)
-  - [Debian/Ubuntu](developers/packaging_debs.md)
+  - [Debian/Ubuntu](developers/debian_ubuntu_packaging.md)
diff --git a/book/src/accounts/policy.md → book/src/accounts/account_policy.md b/book/src/accounts/policy.md → book/src/accounts/account_policy.md
diff --git a/book/src/accounts/anonymous.md → book/src/accounts/anonymous_account.md b/book/src/accounts/anonymous.md → book/src/accounts/anonymous_account.md
diff --git a/book/src/accounts/authentication.md → ...ccounts/authentication_and_credentials.md b/book/src/accounts/authentication.md → ...ccounts/authentication_and_credentials.md
@@ -27,7 +27,7 @@ text=Kanidm's definition of Passkeys may differ from that of other systems. This
 ### Attested Passkeys
 
 These are the same as Passkeys, except that the device must present a cryptographic certificate or
-origin during registration. This allows [account policy](policy.md) to be defined to only allow the
+origin during registration. This allows [account policy](account_policy.md) to be defined to only allow the
 use of certain models of authenticator. In general only FIDO2 keys or TPM's are capable of meeting
 attestation requirements.
 

diff --git a/book/src/accounts/people.md → book/src/accounts/people_accounts.md b/book/src/accounts/people.md → book/src/accounts/people_accounts.md
diff --git a/book/src/accounts/posix.md → ...src/accounts/posix_accounts_and_groups.md b/book/src/accounts/posix.md → ...src/accounts/posix_accounts_and_groups.md
diff --git a/book/src/accounts/service.md → book/src/accounts/service_accounts.md b/book/src/accounts/service.md → book/src/accounts/service_accounts.md
diff --git a/book/src/administrivia.md → book/src/administration.md b/book/src/administrivia.md → book/src/administration.md
@@ -1,4 +1,4 @@
-# Administration Tasks
+# Administration
 
 This chapter describes some of the routine administration tasks for running a Kanidm server, such as
 making backups and restoring from backups, testing server configuration, reindexing, verifying data

diff --git a/book/src/backup_restore.md → book/src/backup_and_restore.md b/book/src/backup_restore.md → book/src/backup_and_restore.md
diff --git a/book/src/client_tools.md b/book/src/client_tools.md
@@ -1,4 +1,4 @@
-# Client tools
+# Client Tools
 
 To interact with Kanidm as an administrator, you'll need to use our command line tools. If you
 haven't installed them yet, [install them now](installing_client_tools.md).

diff --git a/book/src/database_maint.md → book/src/database_maintenance.md b/book/src/database_maint.md → book/src/database_maintenance.md
diff --git a/book/src/developers/packaging_debs.md → ...src/developers/debian_ubuntu_packaging.md b/book/src/developers/packaging_debs.md → ...src/developers/debian_ubuntu_packaging.md
diff --git a/...s/designs/access_profiles_and_security.md → ...opers/designs/access_profiles_original.md b/...s/designs/access_profiles_and_security.md → ...opers/designs/access_profiles_original.md
@@ -1,4 +1,4 @@
-# Access Profiles
+# Access Profiles Original
 
 Access Profiles (ACPs) are a way of expressing the set of actions which accounts are permitted to
 perform on database records (`object`) in the system.

diff --git a/book/src/developers/designs/architecture.md b/book/src/developers/designs/architecture.md
@@ -1,4 +1,4 @@
-## Architectural Overview
+## Architecture
 
 Kanidm has a number of components and layers that make it up. As this project is continually
 evolving, if you have questions or notice discrepancies with this document please contact William

diff --git a/book/src/developers/designs/authentication_flow.md b/book/src/developers/designs/authentication_flow.md
@@ -1,4 +1,4 @@
-# The Authentication Flow
+# Authentication Flow
 
 1. Client sends an init request. This can be either:
    1. `AuthStep::Init` which just includes the username, or

diff --git a/...opers/designs/cryptography-key-domains.md → ...opers/designs/cryptography_key_domains.md b/...opers/designs/cryptography-key-domains.md → ...opers/designs/cryptography_key_domains.md
diff --git a/book/src/developers/designs/domain_join.md → ...s/designs/domain_join_machine_accounts.md b/book/src/developers/designs/domain_join.md → ...s/designs/domain_join_machine_accounts.md
diff --git a/...c/developers/designs/replication_coord.md → ...lopers/designs/replication_coordinator.md b/...c/developers/designs/replication_coord.md → ...lopers/designs/replication_coordinator.md
@@ -1,4 +1,4 @@
-# Replication Coordinator Design
+# Replication Coordinator
 
 Many other IDM systems configure replication on each node of the topology. This means that the
 administrator is responsible for ensuring all nodes are connected properly, and that agreements are

diff --git a/book/src/developers/designs/replication.md → ...s/designs/replication_design_and_notes.md b/book/src/developers/designs/replication.md → ...s/designs/replication_design_and_notes.md
diff --git a/book/src/developers/ethics.md → book/src/developers/developer_ethics.md b/book/src/developers/ethics.md → book/src/developers/developer_ethics.md
@@ -1,4 +1,4 @@
-# Statement of ethics and rights
+# Developer Ethics
 
 Kanidm is a project that will store, process and present people's personal data. This means we have
 a responsibility to respect the data of all people who could be using our system - many who interact

diff --git a/book/src/developers/python.md → book/src/developers/python_module.md b/book/src/developers/python.md → book/src/developers/python_module.md
@@ -1,4 +1,4 @@
-# Kanidm Python Module
+# Python Module
 
 So far it includes:
 

diff --git a/book/src/developers/radius.md → ...c/developers/radius_module_development.md b/book/src/developers/radius.md → ...c/developers/radius_module_development.md
diff --git a/book/src/developers/readme.md b/book/src/developers/readme.md
@@ -13,7 +13,7 @@ consumers - many of who are unlikely to be in a position to contact us to ask fo
 
 ### Ethics / Rights
 
-If you have not already, please see our documentation on [rights and ethics](ethics.md)
+If you have not already, please see our documentation on [rights and ethics](developer_ethics.md)
 
 ### Humans First
 

diff --git a/book/src/developers/release_checklist.md b/book/src/developers/release_checklist.md
@@ -1,4 +1,4 @@
-# Release checklist
+# Release Checklist
 
 ## Pre-Reqs
 

diff --git a/book/src/domain_rename.md b/book/src/domain_rename.md
@@ -1,4 +1,4 @@
-# Rename the domain
+# Domain Rename
 
 There are some cases where you may need to rename the domain. You should have configured this
 initially in the setup, however you may have a situation where a business is changing name, merging,

diff --git a/book/src/quickstart.md → book/src/evaluation_quickstart.md b/book/src/quickstart.md → book/src/evaluation_quickstart.md
@@ -102,4 +102,4 @@ Then follow the presented steps.
 
 ### What next?
 
-You can now follow the steps in the [administration section](administrivia.md)
+You can now follow the steps in the [administration section](administration.md)
diff --git a/book/src/examples/k8s_ingress_example.md → book/src/examples/kubernetes_ingress.md b/book/src/examples/k8s_ingress_example.md → book/src/examples/kubernetes_ingress.md
diff --git a/book/src/integrations/ssh_key_dist.md → .../src/integrations/ssh_key_distribution.md b/book/src/integrations/ssh_key_dist.md → .../src/integrations/ssh_key_distribution.md
diff --git a/book/src/intro.md → book/src/introduction_to_kanidm.md b/book/src/intro.md → book/src/introduction_to_kanidm.md
diff --git a/book/src/monitoring.md → book/src/monitoring_the_platform.md b/book/src/monitoring.md → book/src/monitoring_the_platform.md
diff --git a/book/src/prepare_the_server.md → book/src/preparing_for_your_deployment.md b/book/src/prepare_the_server.md → book/src/preparing_for_your_deployment.md
diff --git a/book/src/server_configuration.md b/book/src/server_configuration.md
@@ -1,4 +1,4 @@
-# Configuring the Server
+# Server Configuration
 
 In this section we will configure your server and create its container instance.
 

diff --git a/book/src/server_update.md → book/src/server_updates.md b/book/src/server_update.md → book/src/server_updates.md
@@ -1,4 +1,4 @@
-# Updating the Server
+# Server Updates
 
 ## General Update Notes
 

diff --git a/book/src/features.md → book/src/supported_features.md b/book/src/features.md → book/src/supported_features.md
diff --git a/book/src/sync/freeipa.md b/book/src/sync/freeipa.md
@@ -1,4 +1,4 @@
-# Synchronising from FreeIPA
+# FreeIPA
 
 FreeIPA is a popular opensource LDAP and Kerberos provider, aiming to be "Active Directory" for
 Linux.

diff --git a/book/src/sync/ldap.md b/book/src/sync/ldap.md
@@ -1,4 +1,4 @@
-# Synchronising from LDAP
+# LDAP
 
 If you have an LDAP server that supports sync repl (rfc4533 content synchronisation) then you are
 able to synchronise from it to Kanidm for the purposes of coexistence or migration.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -102,4 +102,4 @@ Then follow the presented steps.

		### What next?

		You can now follow the steps in the [administration section](administrivia.md)
		You can now follow the steps in the [administration section](administration.md)