Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: restructure docs #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 64 commits into
base: main
Choose a base branch
from
Open

docs: restructure docs #14

wants to merge 64 commits into from

Conversation

lizard-boy
Copy link

Closes coder#13434
Supersedes coder#14182

matifali and others added 30 commits August 23, 2024 10:26
- Improve JSON formatting by adding line breaks for array items
- Shorten "Control Plane Configuration" to "Control Plane" for clarity
Remove outdated introduction and table of contents from the
administration README to improve clarity in the doc structure.

- Eliminated prerequisites and content list placeholders
- Redirected readers to the respective sections for detailed content
Users require these links to correctly configure their git providers.

- GitHub Enterprise: ../configure.md#github-enterprise
- GitLab: ../configure.md#gitlab-self-managed
- BitBucket: ../configure.md#bitbucket-server
- Other Providers: ../configure.md#external-authentication
- Enhance document structure by renaming the main heading.
- Implement XML-style child linking for future content inclusion.
Correct the reference to provisioner authentication to ensure
users can locate the relevant documentation.

- Update the link from `#TODO` to `../provisioners.md`.
matifali and others added 30 commits September 5, 2024 16:43
Enhance navigation by adding relevant icons to improve visual
distinction and accessibility:

- Added `icon_path` for CLI, Docker, Kubernetes, OpenShift
- Enhanced cloud and other install methods with icons
- Updated user guides and control plane sections
- Added icons for infrastructure, users, and templates
- Included icons for provisioners, integrations, workspaces
- Added `icon_path` for networking, monitoring, security
- Included icons for automation and notifications sections
This change updates the icon paths for various documentation sections
to better represent their content.

- Control Plane: ./images/icons/toggle_on.svg
- Monitoring: ./images/icons/speed.svg
- Automation: ./images/icons/plug.svg
- Notifications: ./images/icons/info.svg
- Ensure consistent spell-checking in the codebase
- Added the following terms:
  - `autoupdate`
  - `dbcrypt`
  - `dotfiles`
  - `filebrowser`
  - `jetbrains`
  - `knowledgebase`
  - `netcheck`
  - `portsharing`
  - `speedtest`
  - `unauthenticate`
  - `untar`
  - `userspace`
  - `workspaceproxies`
- Consolidate documentation for external authentication providers.
- Create a dedicated `external-auth.md` for detailed configuration steps.
- Update links in `configure.md` to reflect the changes for ease of navigation.

Additionally:

- Correct broken links.
- Enhance document structure for clarity and ease of use.
* Relocate the notifications page under the monitoring section.
* Update relevant links and image paths.

Changes:
- Rename notifications.md to monitoring/notifications.md.
- Adjust CLI reference links and image paths.
- Update documentation manifest to reflect the new path.
The manifest file erroneously included a duplicate "About" entry. This
commit removes the redundant entry to maintain documentation consistency.
- Change "About" section to "Getting Started" for clarity.
- Update path to improve navigation for new users.
- Improves clarity by using a more intuitive title
- "Setup" better reflects the content's purpose
Relocate automation documentation to the reference section to improve
the organization of the docs. This makes the reference section the
go-to place for automation-related capabilities in Coder.

Changes:
- Moved and deleted `automation.md` from the admin section.
- Updated `manifest.json` to remove the automation entry.
- Transferred content from `automation.md` to `reference/README.md`.

This improves documentation accessibility and organizational clarity.
Reflect the name change in the manifest to improve clarity on user access configuration.

- Rename `docs/admin/configure.md` to `docs/admin/setup.md`
- Update manifest's path to reference the new file name
- Corrected a broken link in the setup documentation.
- Added external authentication entry to docs manifest.

This ensures consistency in navigation and accessibility.
* Provide detailed steps to set up metrics monitoring.
* Include links to Prometheus integration sections.
* Give an overview of default metrics available.
Enhance navigation by incorporating relevant icons for better visual distinction and accessibility.

- Access Workspaces: Added "access.svg"
- Workspace Scheduling: Added "stopwatch.svg"

These changes improve the user experience in navigating the documentation.
Update `README.md` in the user guides section to include an introduction:
- Information on workspace access and personalization
- Clarification on what it does not include for better user direction
- Corrected indentation in `external-auth.md`
- Improved line wrapping in `metrics.md`, `setup.md`, and `README.md`
- Fixed JSON formatting in `manifest.json`
- Enhanced script indentation in `reference/README.md`
- Removed unnecessary blank lines in `user-guides/README.md`
- Provide links for new users setting up control plane
- Offer reference guides for template creation, CLI, and API
- Point to FAQs and Tutorials for additional information
Provide essential information for reporting vulnerabilities and list known security advisories with details on fixes and affected versions.

- Added instructions for reporting vulnerabilities
- Included a table to list known vulnerabilities with severity, fix version, and affected versions
- Added initial entry for API tokens invalidation issue
Update the environment variable for SCIM API key to `CODER_SCIM_AUTH_HEADER`
to ensure consistency with the latest configuration changes.

- Replace `CODER_SCIM_API_KEY` with `CODER_SCIM_AUTH_HEADER`
- Improve readability by fixing line wrapping for the dotfiles module section.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

☂️ Restructure our docs
5 participants