DesignSafe-CI / DS-User-Guide

User Guide for DesignSafe
https://www.designsafe-ci.org/user-guide/
0 stars 8 forks source link

feat: build from tacc docs docker image #1

Closed wesleyboar closed 3 months ago

wesleyboar commented 5 months ago

Overview

Give https://designsafe-ci.org/user-guide/ the theme and features of https://docs.tacc.utexas.edu/ in such a way that other repos can do the same with ease.

Status

Reviewed multiple times by developer, designer, stakeholder, and contributor. Stakeholder says to deploy when I feel comfortable. I will merge into epic/redesign-2024, so further changes are independent of this TACC-Docs PR.

- [x] Developer review \# 1. - [x] Developer review \# 1 updates. #2 - [x] Stakeholder review \# 1. - [x] Stakeholder review \# 1 updates. 57f498f - [x] Deploy. - [x] Document intent to make installable TACC theme. - [x] Use a TACC-Docs version **not** a commit (pre-release of [TACC/TACC-Docs#15](https://github.com/TACC/TACC-Docs/pull/15)). - [x] [Developer review \# 2](https://github.com/DesignSafe-CI/DS-User-Guide/pull/1#pullrequestreview-2041777918). - [x] Developer review \# 2 updates. https://github.com/DesignSafe-CI/DS-User-Guide/pull/1#pullrequestreview-2094707095 https://github.com/DesignSafe-CI/DS-User-Guide/pull/1#pullrequestreview-2069087570 - [x] Stakeholder review \# 2. — 2024/05/28 86c4878, get "Contributor review \#1" - [x] Contributor review \# 1 (@silviamazzoni). - [x] Contributor review \# 1 updates. 51d1367, 6bca8d4, editor can instead use [old nav config](https://github.com/DesignSafe-CI/DS-User-Guide/blob/816dcd1/user-guide/mkdocs.yml#L62-L85) to set title for navigation - ~~Stakeholder review \# 3.~~ I was told I could deploy when I think it is ready. - [x] Swap out the logo with [new one](https://www.designsafe-ci.org/). 3c562755, e29e2bc6

Related

Changes

Testing

Live

[!TIP] Available on DesignSafe "Next" server at /user-guide/.

TACC Theme via Docker

  1. Setup site via Docker or see deploy works at https://pprd.docs.tacc.utexas.edu/.
  2. Verify site has style of https://docs.tacc.utexas.edu/.

Non-Docker Regression Test

  1. Setup site via Python
  2. Verify site has MkDocs readthedocs theme.

Docker & Non-Docker Steps

  1. Verify site has content of https://designsafe-ci.org/user-guide/.
  2. Verify pages load images.
  3. Verify search still works.
  4. Verify Nav behavior matches production.

UI

TACC Theme via Docker— as of 51d1367
via docker
Non-Docker Regression Test — as of 412eff9
via python

Notes

Installing the TACC assets and theme dir as a MkDocs theme is a great idea! See CMD-154: TACC Docs Styles via Installable Theme. Not done yet, because TACC Docs theme might because there is a deadline to meet.

wesleyboar commented 3 months ago

[!IMPORTANT] All reviews and tasks completed for (initial method of) reliance on TACC-Docs.