Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WP-519: APCD Custom getting started page - more standard & compatible #282

Merged
merged 4 commits into from
Mar 27, 2024

Conversation

wesleyboar
Copy link
Member

@wesleyboar wesleyboar commented Mar 27, 2024

Overview

Overwrite template, instead of creating a new one, so that settings need not be updated.*

What is wrong with updating the setting?

Such a settings update in my experience has not been backwards-compatible (prod page will break upon deploy) nor future-compatible (not using a custom template in future, prod page will break upon deploy).

Fail Case

  1. Deploy project

    • with guide template setting path "B"
    • to a server that guide template setting path "A".
  2. Open existing page that uses "Guide: Getting Started" template.

  3. Notice page crash
    (unless someone updated page after deploy via /admin UI to use guide template setting path "A" before visiting the page)

    fail case example

Related

Changes

  • moved a template
    added text to distinguish template from the Core-CMS one it overwrites

Testing

Local

  1. Follow "Start Project" instructions.
  2. Create/Update /apcd-cms/src/taccsite_cms/settings_custom.py with pre–WP-519 settings.
  3. Create a page.
  4. Set template to "Guide: Getting Started".
  5. Verify page content is from modified template.

Remote

  1. Deploy this to a server.
  2. If page is set to use new template, then expect page to fail to load.
  3. If so, then via /admin change template to original template path.
  4. Notice new template is used (at old template path).

UI

new content

If the tempalte is at thsi directory, no settings change is required.
@wesleyboar wesleyboar changed the title Task/wp 519 simplification WP-519: APCD Custom getting started page - more standard & compatible Mar 27, 2024
@chandra-tacc
Copy link
Contributor

Thanks for this fix, works great. Will follow this in future.

@chandra-tacc chandra-tacc merged commit abaaea7 into task/WP-519 Mar 27, 2024
1 check passed
@chandra-tacc chandra-tacc deleted the task/WP-519--simplification branch March 27, 2024 19:22
chandra-tacc added a commit that referenced this pull request Mar 27, 2024
* APCD Custom getting started page

* WP-519: APCD Custom getting started page - more standard & compatible (#282)


---------

Co-authored-by: Wesley B <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants