Skip to content

Commit

Permalink
Switch default branch to main
Browse files Browse the repository at this point in the history
Update deprecated CI develop docs
  • Loading branch information
jayeff committed Mar 3, 2022
1 parent 55ee2e5 commit 88ed0a7
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 18 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ on:
pull_request: ~
push:
branches:
- master
- main

jobs:
documentation:
Expand Down
21 changes: 5 additions & 16 deletions DEVELOP.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,20 +41,14 @@ You must install `fswatch`_ to use the ``dev`` target.
Continuous integration and deployment
=====================================

|build| |travis| |rtd|
|build| |rtd|

Travis CI is `configured`_ to run ``make check`` from the ``docs`` directory.
Please do not merge pull requests until the tests pass.
This project uses GitHub Actions to run make check from the docs directory.

`Read the Docs`_ automatically deploys the documentation whenever a configured
branch is updated.
Also, Read the Docs automatically rebuilds the documentation whenever an active docs branch is updated.

To make changes to the RTD configuration (e.g., to activate or deactivate a
release version), please contact the `@crate/tech-writing`_ team.
To make changes to the RTD configuration (e.g., to activate or deactivate a release version), please contact an admin.


.. _@crate/tech-writing: https://github.com/orgs/crate/teams/tech-writing
.. _configured: https://github.com/crate/sql-99/blob/master/.travis.yml
.. _fswatch: https://github.com/emcrisostomo/fswatch
.. _Read the Docs: http://readthedocs.org
.. _ReStructuredText: http://docutils.sourceforge.net/rst.html
Expand All @@ -63,12 +57,7 @@ release version), please contact the `@crate/tech-writing`_ team.

.. |build| image:: https://img.shields.io/endpoint.svg?color=blue&url=https%3A%2F%2Fraw.githubusercontent.com%2Fcrate%2Fsql-99%2Fmaster%2Fdocs%2Fbuild.json
:alt: Build version
:target: https://github.com/crate/sql-99/blob/master/docs/build.json

.. |travis| image:: https://img.shields.io/travis/crate/sql-99.svg?style=flat
:alt: Travis CI status
:scale: 100%
:target: https://travis-ci.org/crate/sql-99
:target: https://github.com/crate/sql-99/blob/main/docs/build.json

.. |rtd| image:: https://readthedocs.org/projects/sql-99/badge/?version=latest
:alt: Read The Docs status
Expand Down
1 change: 0 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,5 @@ Looking for more help?
.. _Crate.io: http://crate.io/
.. _developer docs: DEVELOP.rst
.. _project docs: https://crate.io/docs/sql-99/en/latest/
.. _Sphinx: http://www.sphinx-doc.org/en/master/
.. _SQL-99 Complete, Really: https://openlibrary.org/books/OL8128443M/SQL-99_Complete_Really
.. _support channels: https://crate.io/support/

0 comments on commit 88ed0a7

Please sign in to comment.