From 816fefc791b037777df41339a4736a998e8fe423 Mon Sep 17 00:00:00 2001
From: Jason Kridner <jkridner@beagleboard.org>
Date: Sun, 3 Jul 2022 18:32:01 -0400
Subject: [PATCH] small fixes
---
.gitlab-ci.yml | 3 +-
_templates/versions.html | 4 +-
conf.py | 2 +-
index-tex.rst | 4 +-
index.rst | 9 ++++-
support.rst | 48 -----------------------
support/index.rst | 85 ++++++++++++++++++++++++++++++++++++++++
7 files changed, 97 insertions(+), 58 deletions(-)
delete mode 100644 support.rst
create mode 100644 support/index.rst
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 42ddb4ac..bdbf91a5 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -18,10 +18,9 @@ pages:
script:
- sphinx-build -b html . public
- sphinx-build -M latexpdf . public
- - mv public/latex/bbdocs.pdf public
+ - mv public/latex/beagleboard-docs.pdf public/
artifacts:
paths:
- public
rules:
- if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH
-
diff --git a/_templates/versions.html b/_templates/versions.html
index b2e36e1e..a87afed3 100644
--- a/_templates/versions.html
+++ b/_templates/versions.html
@@ -14,12 +14,12 @@
</dl>
<dl>
<dt>{{ _('Downloads') }}</dt>
- <dd><a href="bbdocs.pdf">PDF</a></dd>
+ <dd><a href="beagleboard-docs.pdf">PDF</a></dd>
</dl>
<dl>
<dt>{{ _('BeagleBoard.org Links') }}</dt>
<dd>
- <a href="https://git.beagleboard.org/docs/docs.beagleboard.io/">Docs</a>
+ <a href="https://git.beagleboard.org/docs/docs.beagleboard.io/">Docs Source</a>
</dd>
</dl>
</div>
diff --git a/conf.py b/conf.py
index c358fe6f..038b203e 100644
--- a/conf.py
+++ b/conf.py
@@ -110,7 +110,7 @@ latex_elements = {
}
latex_logo = str(BBDOCS_BASE / "_static" / "images" / "logo-latex.pdf")
latex_documents = [
- ("index-tex", "bbdocs.tex", "BeagleBoard Docs", author, "manual"),
+ ("index-tex", "beagleboard-docs.tex", "BeagleBoard Docs", author, "manual"),
]
def setup(app):
diff --git a/index-tex.rst b/index-tex.rst
index 9e115759..2a301eab 100644
--- a/index-tex.rst
+++ b/index-tex.rst
@@ -10,8 +10,6 @@ BeagleBoard Docs
.. toctree::
- :maxdepth: 1
- :caption: Boards:
-
+ support/index.rst
beaglebone-black/index.rst
beaglebone-ai-64/index.rst
\ No newline at end of file
diff --git a/index.rst b/index.rst
index 1154cddc..67928e42 100644
--- a/index.rst
+++ b/index.rst
@@ -11,13 +11,18 @@ Sections
.. toctree::
:maxdepth: 1
- :caption: Boards:
+ :caption: Support
+
+ support/index.rst
+
+.. toctree::
+ :maxdepth: 1
+ :caption: Boards
beaglebone-black/index.rst
beaglebone-ai-64/index.rst
-
Indices and tables
############################
diff --git a/support.rst b/support.rst
deleted file mode 100644
index e839299d..00000000
--- a/support.rst
+++ /dev/null
@@ -1,48 +0,0 @@
-# Support
-
-## Getting started
-
-The starting experience for all Beagles has been made to be as consistent as is possible. For any of the Beagle Linux-based open hardware computers, visit our [getting started guide](https://docs.beagleboard.org/support/getting-started).
-
-## Getting support
-
-BeagleBoard.org products and [open hardware](https://www.oshwa.org/definition/) designs are supported via the on-line community resources. We are very confident in our community's ability to provide useful answers in a timely manner. If you don't get a productive response within 24 hours, please escalate issues to Jason Kridner \(contact info available on the [About Page](https://beagleboard.org/about)\). In case it is needed, Jason will help escalate issues to suppliers, manufacturers or others. Be sure to provide a link to your questions on the [community forums](https://forum.beagleboard.org) as answers will be provided there.
-
-## Diagnostic tools
-
-Best to be prepared with good diagnostic information to aide with support.
-
-* [Example run of 'version.sh' script needed for support requests](https://groups.google.com/d/msg/beagleboard/4oo4oL20BEs/MVwxfR-XCAAJ)
-* [Beagle Tester source](https://github.com/jadonk/beagle-tester)
-* [Beagle Tester image releases](https://github.com/beagleboard/buildroot/releases)
-
-## Community resources
-
-Please execute the board diagnostics, review the hardware documentation, and consult the mailing list and IRC channel for support. BeagleBoard.org is a "community" project with free support only given to those who are willing to discussing their issues openly for the benefit of the entire community.
-
-* [Frequently Asked Questions](https://beagleboard.org/support/faq)
-* [Mailing List](https://forum.beagleboard.org)
-* [Live Chat](https://beagleboard.org/chat)
-
-## Consulting and other resources
-
-Need timely response or contract resources because you are building a product?
-
-* [Resources](https://beagleboard.org/resources)
-
-## Repairs
-
-Repairs and replacements only provided on unmodified boards purchased via an authorized distributor within the first 90 days. All repaired board will have their flash reset to factory contents. For repairs and replacements, please contact 'support' at BeagleBoard.org using the RMA form:
-
-* [RMA request](https://beagleboard.org//support/rma)
-
-## Understanding Your Beagle
-
-* [BeagleBone Introduction](https://beagleboard.org//Support/bone101)
-* [Hardware](https://beagleboard.org//Support/Hardware+Support)
-* [Software](https://beagleboard.org//Support/Software+Support)
-* [BoneScript JavaScript library](https://beagleboard.org//Support/bonescript)
-* [Books](https://beagleboard.org//books)
- * [Exploring BeagleBone](https://beagleboard.org//ebb)
- * [BeagleBone Cookbook](https://beagleboard.org//cookbook)
- * [Bad to the Bone](https://beagleboard.org//bad-to-the-bone)
\ No newline at end of file
diff --git a/support/index.rst b/support/index.rst
new file mode 100644
index 00000000..4ac51527
--- /dev/null
+++ b/support/index.rst
@@ -0,0 +1,85 @@
+Support
+=======
+
+.. note:: #TODO# all the links need updating and content moved into this repo.
+
+Getting started
+---------------
+
+The starting experience for all Beagles has been made to be as
+consistent as is possible. For any of the Beagle Linux-based open
+hardware computers, visit our `getting started
+guide <support/getting-started>`__.
+
+Getting support
+---------------
+
+BeagleBoard.org products and `open
+hardware <https://www.oshwa.org/definition/>`__ designs are supported
+via the on-line community resources. We are very confident in our
+community’s ability to provide useful answers in a timely manner. If you
+don’t get a productive response within 24 hours, please escalate issues
+to Jason Kridner (contact info available on the `About
+Page <https://beagleboard.org/about>`__). In case it is needed, Jason
+will help escalate issues to suppliers, manufacturers or others. Be sure
+to provide a link to your questions on the `community
+forums <https://forum.beagleboard.org>`__ as answers will be provided
+there.
+
+Diagnostic tools
+----------------
+
+Best to be prepared with good diagnostic information to aide with
+support.
+
+- `Example run of ‘version.sh’ script needed for support
+ requests <https://groups.google.com/d/msg/beagleboard/4oo4oL20BEs/MVwxfR-XCAAJ>`__
+- `Beagle Tester source <https://github.com/jadonk/beagle-tester>`__
+- `Beagle Tester image
+ releases <https://github.com/beagleboard/buildroot/releases>`__
+
+Community resources
+-------------------
+
+Please execute the board diagnostics, review the hardware documentation,
+and consult the mailing list and IRC channel for support.
+BeagleBoard.org is a “community†project with free support only given to
+those who are willing to discussing their issues openly for the benefit
+of the entire community.
+
+- `Frequently Asked Questions <https://beagleboard.org/support/faq>`__
+- `Mailing List <https://forum.beagleboard.org>`__
+- `Live Chat <https://beagleboard.org/chat>`__
+
+Consulting and other resources
+------------------------------
+
+Need timely response or contract resources because you are building a
+product?
+
+- `Resources <https://beagleboard.org/resources>`__
+
+Repairs
+-------
+
+Repairs and replacements only provided on unmodified boards purchased
+via an authorized distributor within the first 90 days. All repaired
+board will have their flash reset to factory contents. For repairs and
+replacements, please contact ‘support’ at BeagleBoard.org using the RMA
+form:
+
+- `RMA request <https://beagleboard.org//support/rma>`__
+
+Understanding Your Beagle
+-------------------------
+
+- `BeagleBone Introduction <https://beagleboard.org/Support/bone101>`__
+- `Hardware <https://beagleboard.org/Support/Hardware+Support>`__
+- `Software <https://beagleboard.org/Support/Software+Support>`__
+- `BoneScript JavaScript
+ library <https://beagleboard.org/Support/bonescript>`__
+- `Books <https://beagleboard.org/books>`__
+
+ - `Exploring BeagleBone <https://beagleboard.org/ebb>`__
+ - `BeagleBone Cookbook <https://beagleboard.org/cookbook>`__
+ - `Bad to the Bone <https://beagleboard.org/bad-to-the-bone>`__
--
GitLab