Skip to content
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

[DRAFT/PROPOSAL] change naming/documentation approach from 'Airgapped Docs' to offline documentation #113

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

CamrynCarter
Copy link
Contributor

The Airgapped Docs section is somewhat misleading, because it looks like a section of the documentation on how to set up an airgapped environment. The documentation also treats "Airgapped Docs" as an additional product, instead of a feature addition to Carbide that can be installed/enabled.

The goal of this PR is to lessen that confusion by changing the reference to "offline documentation". This is self-explanatory but moves away from the "airgapped" language used throughout the rest Carbide documentation to describe setting up the product in an airgapped environment. Offline is also less prescriptive and could appeal to customers in low/off-and-on connectivity but not full airgap.

Question... I take it the carbide chart is named 'airgapped-docs'? Could we change this to 'offline-docs' for consistency if we want to proceed with this change?

@CamrynCarter CamrynCarter marked this pull request as draft October 10, 2024 23:05
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.

1 participant