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

Add subscription docs #74

Merged
merged 4 commits into from
Jan 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ All notable changes to this project will be documented in this file.
### Added

- Release instructions to README.
- Subscription management docs.

### Fixed

Expand Down
7 changes: 7 additions & 0 deletions docs/src/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,13 @@ CriticalUp User Documentation
using-criticalup/toolchain-management
using-criticalup/running-tools

.. toctree::
:numbered:
:maxdepth: 2
:caption: Ferrocene Subscription:

subscriptions

.. toctree::
:numbered:
:maxdepth: 2
Expand Down
1 change: 1 addition & 0 deletions docs/src/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ This guide contains the following chapters:
CriticalUp.
* *Using CriticalUp* describes how to use CriticalUp to manage Ferrocene
installations.
* *Managing Subscriptions* describes how to manage your subscription.
* *References* provides further support and information about other
documentation.

13 changes: 13 additions & 0 deletions docs/src/subscriptions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.. SPDX-FileCopyrightText: The Ferrocene Developers
.. SPDX-License-Identifier: MIT OR Apache-2.0

.. _subscriptions:

Managing Subscriptions
======================

This chapter describes how to make changes to your Ferrocene subscription.

- If you subscribed to Ferrocene with a credit card, you can make changes to your subscription in your `Billing Portal <https://customers.ferrocene.dev/stripe/billing>`_.

- If you have an Enterprise Subscription, email your billing contact to make changes to your subscription.
13 changes: 5 additions & 8 deletions docs/src/using-criticalup/authenticating.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,24 @@ Authenticating
This chapter describes how to authenticate CriticalUp on the
`Ferrocene Customer Portal`_.

The example assumes you have a preexisting Ferrocene account. This example
presumes no existing directory structure.
You need a Ferrocene subscription to authenticate CriticalUp and download Ferrocene.

.. _Ferrocene Customer Portal: https://customers.ferrocene.dev/

After :ref:`installing CriticalUp <install>` it's possible to authenticate
CriticalUp via the ``auth set`` subcommand.

After :ref:`installing CriticalUp <install>`, authenticate by running the ``auth set`` subcommand:

.. code-block::

criticalup auth set

Follow the on-screen instructions to generate a new token, then paste the token
into the prompt. CriticalUp will validate that the provided token is valid.
into the prompt. CriticalUp will validate the token.


Check Authentication Status
^^^^^^^^^^^^^^^^^^^^^^^^^^^

The current authentication state and token used can be reviewed with the ``auth`` command.
Review authentication and token state using the ``auth`` command.

.. code-block::

Expand All @@ -39,7 +36,7 @@ The current authentication state and token used can be reviewed with the ``auth`
Unauthenticating
^^^^^^^^^^^^^^^^

In order to remove the authenticated token, the ``auth remove`` command can be used.
To remove the authenticated token, run ``auth remove``.

.. code-block::

Expand Down
Loading