From f25b41c23bb81485bb37be2698b8459889f80a08 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Fri, 25 Nov 2022 09:07:05 -0800 Subject: [PATCH] Update About page -> How it works This makes it a bit more obvious what the page is about, and isn't confused with the `About us` page. --- content/pages/about.html | 426 ------------------ .../templates/includes/topnav.html | 2 +- 2 files changed, 1 insertion(+), 427 deletions(-) delete mode 100644 content/pages/about.html diff --git a/content/pages/about.html b/content/pages/about.html deleted file mode 100644 index 1bb6c98a..00000000 --- a/content/pages/about.html +++ /dev/null @@ -1,426 +0,0 @@ - - - About - - - - - - -{% import "partials/homepage.html" as homepage %} -{% import "partials/about.html" as about %} - -
-
-
-
- -
-
-

- How automatic documentation deployment works -

- - {% markdown %} - Automate the deployment of your technical documentation - by building your project with every change to your documentation source. - Maintain your documentation without managing extra services. - Building, hosting, CDN, authentication, and search are all included. - {% endmarkdown %} - -
-
- -
-
-
- - {%- set header_1 = "Maintain docs as code" %} - {%- set icon_1 = "fa-code-branch" -%} - - - - {{ header_1 }} - Use your existing development workflow to maintain your documentation - - - - {%- set header_2 = "Build automatically" %} - {%- set icon_2 = "fa-gears" -%} - - - - {{ header_2 }} - Update your documentation whenever you push changes - - - - {%- set header_3 = "Preview your changes" %} - {%- set icon_3 = "fa-code-compare" -%} - - - - {{ header_3 }} - Verify changes to your documentation during review - - - - {%- set header_4 = "Everything in one place" %} - {%- set icon_4 = "fa-box-check" -%} - - - - {{ header_4 }} - We manage building, hosting, authentication, search, and analytics for you - - -
-
-
- -
-
-
-
- -{% macro about_divide(text=None) %} -
-
- {% if text %}{{ text }}{% endif %} -
-
-{% endmacro %} - -{{ about_divide() }} - -
-
-
- - {% call about.step( - header=header_1, - image="/images/about/authoring.png", - image_alt="Terminal window showing commands to commit documentation changes", - icon=icon_1) %} - {% markdown %} - Manage software documentation using all of the **same tools and workflow** - you're already using for development. Write docs with your favorite editor, - commit changes using version control, and preview changes during review. - {% endmarkdown %} - {% endcall %} - - {% call homepage.feature_detail_item(header="Versioning", icon="fad fa-layer-group") %} - Give your users documentation that won't go out of date. - Build multiple versions from commits, branches, or tags in your repository. - {% endcall %} - - {% call homepage.feature_detail_item(header="Localization", icon="fad fa-language") %} - Integrate with localization tools to translate your documentation in multiple languages. - {% endcall %} - - {% call homepage.feature_detail_item(header="Track change history", icon="fad fa-code-commit") %} - Use the same version control system that you use for development to retain change history for your documentation. - {% endcall %} - - {% block authoring_details %} -
-
- - {% block authoring_details_providers %} -
-
-

- - Bring your own tools -

- - {% markdown %} - Integrate with tools like **Sphinx**, **MkDocs**, and **Jupyter Book**, - and track changes with **Git** or **Mercurial**. - Use the tools that work best for your project. - {% endmarkdown %} -
-
- -
-
- - {% markdown %} - * Write **reStructuredText** with **Sphinx** - * Or write **Markdown** with **Sphinx** and **MyST** - * Add reference docs from **Python** code - * Document a RESTful API with **OpenAPI** tools - * Include a **Jupyter Notebook** in your docs - {% endmarkdown %} - -
-
- {% endblock authoring_details_providers %} - -
-
- {% endblock authoring_details %} - -
-
- - {{ about_divide() }} - -
-
- - {% call about.step( - header=header_2, - image="/images/about/building.png", - image_alt="Project building on Read the Docs", - icon=icon_2) %} - {% markdown %} - Your documentation is rebuilt whenever a change is detected in your repository, - so every version of your documentation is **always up to date**. - - Whether your project is **Python** or **Node.js**, your project controls - what dependencies to install and how to generate your documentation. - {% endmarkdown %} - {% endcall %} - - {% call homepage.feature_detail_item(header="Build customization", icon="fad fa-sparkles") %} - Customize your documentation build to fit your needs. Install your own dependencies and run custom commands. - {% endcall %} - - {% call homepage.feature_detail_item(header="Configuration file", icon="fad fa-file-code") %} - Set up your project and track your project's configuration from your repository. - {% endcall %} - - {% call homepage.feature_detail_item(header="Offline formats", icon="fad fa-file-pdf") %} - Output PDF and EPUB formats for your documentation, for offline and cross-device viewing. - {% endcall %} - - {% block building_details %} -
-
- - {% block building_details_providers %} -
-
- -

- - Connect to all of your repositories -

- - {% markdown %} - Read the Docs integrates with **GitHub**, **GitLab**, and **Bitbucket** - and can clone and build documentation from any hosted repository. - You can also manually connect to any repository provider that supports - **Git**. - {% endmarkdown %} - -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -

- - - Private repository support - - - Paid plan feature - - -

- - {% markdown %} - Clone from private repositories hosted on GitHub, GitLab, and Bitbucket, - or connect another provider by manually connecting using a provided key. - {% endmarkdown %} - -
-
- {% endblock building_details_providers %} - -
-
- {% endblock building_details %} - -
-
- - {{ about_divide() }} - -
-
- - {% call about.step( - header=header_3, - image="/images/about/review.png", - image_alt="Read the Docs pull request review checks in a GitHub pull request", - icon=icon_3) %} - {% markdown %} - Rebuild your documentation and preview changes in every pull request. - Share changes easily and help catch errors before shipping documentaiton updates. - - Supported on **GitHub** and **GitLab** repositories. - {% endmarkdown %} - - - Learn more - - {% endcall %} - -
-
- - {{ about_divide() }} - -
-
- - {% call about.step( - header=header_4, - image=None, - icon=icon_4) %} - {% markdown %} - Everything you need to deliver documentation to your users and customers - is already included with your project. You can easily deploy multiple versions - of your documentation, with everything from authentication to cross-project - search, without configuring any additional services. - {% endmarkdown %} - {% endcall %} - -
-
-

- For every project type -

- -
-
- -
- Host public documentation for users -
-
-
- -
- Share documentation internally using teams -
-
-
- -
- Grant access using sharing tokens -
-
-
-
-
- - {% call homepage.feature_detail_item(header="Authentication", icon="fad fa-fingerprint", paid=True) %} - Control who has access to your documentation with integrated authentation and sharing tokens. - {% endcall %} - - {% call homepage.feature_detail_item(header="Bring your domain", icon="fad fa-at") %} - Use your own custom domain for your hosted documentation, with SSL automatically configured. - {% endcall %} - - {% call homepage.feature_detail_item(header="Integrated search", icon="fad fa-search") %} - Help your users find what the need with integrated search across all your projects and versions. - {% endcall %} - -
-
-
- -
-
-
-
-
-

- Start automating your documentation with Read the Docs. -

-

- -

- -
-
-
-
-
- -{% block homepage_modal %} - {{ homepage.signup_modal("about-modal") }} -{% endblock homepage_modal %} - -
- - {{ about_divide("Additional features") }} - -
-
- - {% call homepage.feature_detail_item(header="Automation rules", icon="fad fa-robot") %} - Automatically increment your documentation versions, and rebuild on new version releases. - {% endcall %} - - {% call homepage.feature_detail_item(header="Subprojects", icon="fad fa-folder-tree") %} - Subprojects can share a search index and a custom domain, and can help logically group sets of multiple projects. - {% endcall %} - - {% call homepage.feature_detail_item(header="Environment variables", icon="fad fa-shield-keyhole") %} - Use environment variables to provide secrets to your project's build commands. - {% endcall %} - - {% call homepage.feature_detail_item(header="Redirects", icon="fad fa-signs-post") %} - Avoid broken links by adding redirects for pages that have been moved or deleted. - {% endcall %} - - {% call homepage.feature_detail_item(header="Analytics", icon="fad fa-chart-column") %} - Track search query and documentation page traffic data with no additional services. - {% endcall %} - - {% call homepage.feature_detail_item(header="Webhooks", icon="fad fa-satellite-dish") %} - Connect Read the Docs to other services by sending webhook events after each build. - {% endcall %} - - {% call homepage.feature_detail_item(header="Notifications", icon="fad fa-envelope-dot") %} - Receive email notifications when a project build encounters an error. - {% endcall %} - - {% call homepage.feature_detail_item(header="Audit log", icon="fad fa-clipboard-list", paid=True) %} - Track and review authentication attempts for your organization and all of your private documentation projects. - {% endcall %} - - {% call homepage.feature_detail_item(header="Team management", icon="fad fa-people-group", paid=True) %} - Control access to your projects within your organization and group projects by teams. - {% endcall %} - -
-
-
- - - diff --git a/readthedocs_theme/templates/includes/topnav.html b/readthedocs_theme/templates/includes/topnav.html index 5898a348..2a9c4e40 100644 --- a/readthedocs_theme/templates/includes/topnav.html +++ b/readthedocs_theme/templates/includes/topnav.html @@ -1,5 +1,5 @@ {% macro menu_main() %} - About + How it works Pricing {% endmacro %}