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

Clarify CMS instructions #1029

Open
yndajas opened this issue Nov 25, 2022 · 0 comments
Open

Clarify CMS instructions #1029

yndajas opened this issue Nov 25, 2022 · 0 comments

Comments

@yndajas
Copy link
Member

yndajas commented Nov 25, 2022

Action

Clarify what each of the save/status/publish buttons and menus do in the Playbook CMS. The steps in Suggesting a change are clear enough, but the number of other, unexplained buttons and menus is bewildering. A breakdown somewhere else in the contributing guide would be helpful, if not a code change to disable unused interactables

The long story

When opening a PR recently via the CMS, I was bewildered by the various buttons and menus. The contributing page says that you should click on 'save', then change the status from 'draft' to 'in review', but on doing this I noticed it had tagged the automatic PR differently to other content change PRs. I guessed all was fine, but I wondered why this happened

Even having gone through this process, I was still unclear what the different buttons/menus trigger. In starting to write this issue, I went into a page and clicked "Save" so that the two menus to the right would show up. I assumed this would save it as a draft within the CMS, perhaps even a draft specific to me, but it actually then created a PR straight away (presumably my expectation was wrong since this is a static site with no backend, but I'm too used to WordPress as a CMS)

It's also unclear why we have three statuses - "draft", "in review" and "ready" - when saving alone creates a PR. I suppose you might save and then continue to make and save changes until it's ready for review, but then what does "ready" mean if not "ready for review"?

In addition, there's a further menu to the right with options to "publish now", "publish and create new" and "publish and duplicate". I don't know what the last two mean, but mostly I'm unclear on the ramifications of clicking the first one - does this completely bypass/self-approve the PR you made when clicking save? Is this okay? At first, I assumed this might be the point at which a saved change was submitted as a PR, but having read the contributing instructions I held off clicking it

Screenshots

Screenshot 2022-11-25 at 12 50 39

Screenshot 2022-11-25 at 12 50 45

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant