Docs: Update Sphinx theme to v1x by lauranovich · Pull Request #802 · scylladb/scylla-operator

lauranovich · 2021-10-06T10:35:28Z

Upgrades the Scylla Theme to v1.x
This change does not include any HP fixes or any other issues which will be handled with additional PRs. Please merge this FIRST.

Description of your changes:

Which issue is resolved by this Pull Request:
Resolves #

Upgrades the Scylla Theme to v1.x This change does not include any HP fixes or any other issues which will be handled with additional PRs. Please merge this FIRST.

lauranovich · 2021-10-06T10:41:02Z

@dgarcia360 please take a look - the build has an error - works locally

lauranovich · 2021-10-06T10:54:56Z

The following error has been noted

/home/lauranovich/github-repo/laura-operator/docs/source/migration.md: WARNING: document isn't included in any toctree
/home/lauranovich/github-repo/laura-operator/docs/source/nodeoperations/automatic_cleanup.md: WARNING: document isn't included in any toctree
/home/lauranovich/github-repo/laura-operator/docs/source/nodeoperations/maintenance_mode.md: WARNING: document isn't included in any toctree
/home/lauranovich/github-repo/laura-operator/docs/source/nodeoperations/replace_node.md: WARNING: document isn't included in any toctree
/home/lauranovich/github-repo/laura-operator/docs/source/nodeoperations/restore.md: WARNING: document isn't included in any toctree
/home/lauranovich/github-repo/laura-operator/docs/source/nodeoperations/scylla_upgrade.md: WARNING: document isn't included in any toctree

tzach · 2021-10-06T11:01:28Z

@lauranovich are these warning a regression ?

lauranovich · 2021-10-06T11:03:41Z

@tzach they were there before - it wasn't caused by the upgrade

lauranovich · 2021-10-06T11:21:16Z

The error is fixed in this PR -> #804

tzach

LGTM

dgarcia360 · 2021-10-06T15:37:02Z

Looks good to me. Since the repo is open-source, we could also enable the "Edit on GitHub" button.

lauranovich · 2021-10-06T16:25:31Z

In the next PR I'll make those changes

tnozicka

thanks for bumping our sphinx theme! a few technical comments on the machinery

tnozicka · 2021-10-07T05:35:43Z

  push:
    branches:
-    - master
+      - master


let's be consistent an not change the spacing, we use yaml arrays without extra indentation when user written (applies globally)

tnozicka · 2021-10-07T05:36:30Z

+      - master
    paths:
-    - 'docs/**'
+      - "docs/**"


probably a not needed diff

tnozicka · 2021-10-07T05:36:58Z

+        run: ./docs/_utils/deploy.sh
        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}


\n is missing

Suggested change

GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

tnozicka · 2021-10-07T05:41:28Z

 jobs:
  release:
-    name: Release docs
+    name: Build


given one of the steps actually deploys the docs and the job ID is "release", naming it "Build" seems a bit confusing

Suggested change

name: Build

name: Release

tnozicka · 2021-10-07T05:43:20Z

+        run: |
+          export PATH=$PATH:~/.local/bin
+          cd docs
+          make test


make -C docs test

tnozicka · 2021-10-07T05:44:31Z

 ALLSPHINXOPTS   := -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR)
 # the i18n builder cannot share the environment and doctrees with the others
 I18NSPHINXOPTS  := $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR)
+TESTSPHINXOPTS  = $(ALLSPHINXOPTS) -W --keep-going


:= for immediate evaluation

Suggested change

TESTSPHINXOPTS = $(ALLSPHINXOPTS) -W --keep-going

TESTSPHINXOPTS := $(ALLSPHINXOPTS) -W --keep-going

tnozicka · 2021-10-07T05:52:58Z

do we need the version suffixes in workflow's file names?

tnozicka · 2021-10-07T06:34:49Z

the new job failed (https://github.com/scylladb/scylla-operator/runs/3813890866?check_suite_focus=true#step:4:175) and needs to be fixed first.

(note to myself or @zimnx - we need to add that job as required when this lands)

tnozicka · 2021-10-07T06:37:55Z

@@ -0,0 +1,28 @@
+name: "Build docs on pull requests"


looking at the GH status contexts

Build docs on pull requests / Build (pull_request) Failing after 1m — Build Go / Verify (pull_request) Successful in 3m

would it be nicer to name it Docs / Build ?

Suggested change

name: "Build docs on pull requests"

name: "Docs / Build PR"

dgarcia360 · 2021-10-07T07:41:35Z

@@ -1,15 +1,14 @@
-name: Release docs
+name: "Publish docs to GitHub Pages"


Suggested change

name: "Publish docs to GitHub Pages"

name: "Docs / Publish"

dgarcia360 · 2021-10-07T07:46:21Z

Many thanks @tnozicka @zimnx for the feedback!

We are going to add some of your suggestions to the Scylla Sphinx Theme repository.

do we need the version suffixes in workflow's file names?

We are adding these workflows to many projects. Versioning helps us know which version of the file each project is using.

tzach · 2021-10-20T08:09:03Z

@dgarcia360 what is the next step for this PR?

dgarcia360 · 2021-10-20T14:18:18Z

I've addressed the comments in #815, this PR can be closed.

update theme to v1x

6b9c987

Upgrades the Scylla Theme to v1.x This change does not include any HP fixes or any other issues which will be handled with additional PRs. Please merge this FIRST.

lauranovich added the kind/documentation Categorizes issue or PR as related to documentation. label Oct 6, 2021

update theme to v1x

f26fc42

Upgrades the Scylla Theme to v1.x This change does not include any HP fixes or any other issues which will be handled with additional PRs. Please merge this FIRST.

lauranovich modified the milestones: v1.5, v1.6 Oct 6, 2021

lauranovich mentioned this pull request Oct 6, 2021

Fix build error due to index not including all files #804

Closed

tzach approved these changes Oct 6, 2021

View reviewed changes

tnozicka self-requested a review October 6, 2021 16:40

tnozicka added the priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. label Oct 6, 2021

tnozicka self-assigned this Oct 6, 2021

tnozicka reviewed Oct 7, 2021

View reviewed changes

tnozicka requested a review from zimnx October 7, 2021 06:30

tnozicka reviewed Oct 7, 2021

View reviewed changes

dgarcia360 reviewed Oct 7, 2021

View reviewed changes

lauranovich mentioned this pull request Oct 10, 2021

Fix build errors in TOC and index. Add Index file to node operations directory #807

Merged

dgarcia360 mentioned this pull request Oct 19, 2021

Install new theme on all the other projects scylladb/sphinx-scylladb-theme#133

Closed

11 tasks

This was referenced Oct 20, 2021

Add prerequisites scylladb/sphinx-scylladb-theme#236

Merged

Add Scylla Sphinx Theme 1.0 #815

Closed

dgarcia360 mentioned this pull request Oct 20, 2021

Add Scylla Sphinx Theme 1.0 scylladb/cpp-driver#50

Merged

tnozicka closed this Oct 26, 2021

	GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
	GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

	TESTSPHINXOPTS = $(ALLSPHINXOPTS) -W --keep-going
	TESTSPHINXOPTS := $(ALLSPHINXOPTS) -W --keep-going

		@@ -1,15 +1,14 @@
		name: Release docs
		name: "Publish docs to GitHub Pages"

Conversation

lauranovich commented Oct 6, 2021

Uh oh!

lauranovich commented Oct 6, 2021

Uh oh!

lauranovich commented Oct 6, 2021

Uh oh!

tzach commented Oct 6, 2021

Uh oh!

lauranovich commented Oct 6, 2021

Uh oh!

lauranovich commented Oct 6, 2021

Uh oh!

tzach left a comment

Choose a reason for hiding this comment

Uh oh!

dgarcia360 commented Oct 6, 2021

Uh oh!

lauranovich commented Oct 6, 2021

Uh oh!

tnozicka left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tnozicka commented Oct 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tnozicka commented Oct 7, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dgarcia360 Oct 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dgarcia360 commented Oct 7, 2021

Uh oh!

tzach commented Oct 20, 2021

Uh oh!

dgarcia360 commented Oct 20, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tnozicka commented Oct 7, 2021 •

edited

Loading

dgarcia360 Oct 7, 2021 •

edited

Loading