Skip to content

Commit 4e99ac8

Browse files
authored
Merge pull request #5 from dfrnt-labs/convert/tailwind
content fix
2 parents 90342ad + eeca5d4 commit 4e99ac8

File tree

3 files changed

+118
-3
lines changed

3 files changed

+118
-3
lines changed

public/staticwebapp.config.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
],
1313
"responseOverrides": {
1414
"404": {
15-
"rewrite": "/404.tsx"
15+
"rewrite": "/404"
1616
}
1717
}
18-
}
18+
}
Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
---
2+
title: Change Request Workflows in TerminusCMS
3+
slug: change-request-workflows-terminuscms-tour
4+
seo:
5+
title: Change Request Workflows - TerminusCMS Tour
6+
description: >-
7+
This page details how change request workflows function in TerminusCMS to
8+
enable safe collaboration
9+
og_image: >-
10+
https://assets.terminusdb.com/docs/technical-documentation-terminuscms-og.png
11+
media:
12+
- alt: Opening a change request
13+
caption: ''
14+
media_type: Image
15+
title: Opening a change request
16+
value: https://assets.terminusdb.com/docs/open-change-request.png
17+
- alt: In a change request
18+
caption: ''
19+
media_type: Image
20+
title: In a change request
21+
value: https://assets.terminusdb.com/docs/in-change-request.png
22+
- alt: TerminusCMS change request screen
23+
caption: ''
24+
media_type: Image
25+
title: TerminusCMS change request screen
26+
value: https://assets.terminusdb.com/docs/change-request-screen.png
27+
- alt: Change Request diff viewer
28+
caption: ''
29+
media_type: Image
30+
title: Change Request diff viewer
31+
value: https://assets.terminusdb.com/docs/cr-diff.png
32+
- alt: See messages in a change request for context
33+
caption: ''
34+
media_type: Image
35+
title: See messages in a change request for context
36+
value: https://assets.terminusdb.com/docs/cr-review-messages.png
37+
- alt: List of change requests for review
38+
caption: ''
39+
media_type: Image
40+
title: List of change requests for review
41+
value: https://assets.terminusdb.com/docs/cr-review-home.png
42+
- alt: Change request screen
43+
caption: ''
44+
media_type: Image
45+
title: Change request screen
46+
value: https://assets.terminusdb.com/docs/cr-review-page.png
47+
---
48+
49+
TerminusCMS features change request workflows to ensure that changes to data and content are made safely with reviews in place to check changes.
50+
51+
## Creating a Change Request
52+
53+
When someone goes to make a change to content and data, TerminusCMS automatically opens a change request. This is a branch of the database that does not impact main. Users can make one or many changes within the change request -
54+
55+
![Opening a change request](https://assets.terminusdb.com/docs/open-change-request.png)
56+
57+
## In a Change Request
58+
59+
Users will see when they are in a change request. A banner with various options is included at the top of the page and there is also a notice on the left informing the user what they are connected to -
60+
61+
![In a change request](https://assets.terminusdb.com/docs/in-change-request.png)
62+
63+
> It is important to submit edits or additions in a change request. Without hitting the submit button, changes will not be saved to the change request.
64+
65+
When in a change request a user has three options -
66+
67+
1. Continue to make edits, deletions, and additions to the change request.
68+
2. Exit the change request - This leaves the change request open and available to come back to at a later stage.
69+
3. Submit the change request for review.
70+
71+
## Change Request Admin
72+
73+
Change requests are managed from the change request screen.
74+
75+
![TerminusCMS change request screen](https://assets.terminusdb.com/docs/change-request-screen.png)
76+
77+
The screen has four tabs -
78+
79+
1. Open - Open change requests that can be continued with or submitted for review.
80+
2. Review - Change requests that have been submitted for review.
81+
3. Merged - Previous approved commits to the database.
82+
4. Rejected - Rejected change requests.
83+
84+
## Review Change Requests
85+
86+
On the change request screen, select 'review'. Change requests that users have submitted for review are listed in chronological order.
87+
88+
![Change Request diff viewer](https://assets.terminusdb.com/docs/cr-diff.png)
89+
90+
_Change requests feature a diff viewer to see what's changed_
91+
92+
![See messages in a change request for context](https://assets.terminusdb.com/docs/cr-review-messages.png)
93+
94+
_Write messages to add more context_
95+
96+
![List of change requests for review](https://assets.terminusdb.com/docs/cr-review-home.png)
97+
98+
![Change request screen](https://assets.terminusdb.com/docs/cr-review-page.png)
99+
100+
To review a change request, do the following -
101+
102+
* Click the 'review' button for the corresponding change request.
103+
* The next screen has all of the details of the change request with two tabs -
104+
105+
* The first is the diff view with drop-down options to display the changes that have been made
106+
* The second is the messages tab, this displays the messages entered when creating and submitting the change request and can provide context.
107+
108+
* Users can either accept or reject a change request and leave a message explaining their reasoning behind each
109+
* Accepted change requests will move the change request into the merged tab - users are able to view the diff to see the changes of past commits
110+
* Rejected change requests move into the rejected tab on the change request home screen
111+
112+
## Conflicts & Collaboration
113+
114+
In order to avoid changes being squashed by other users when multiple people make changes to data and content, TerminusCMS checks the database to see if there have been changes made before a user reviews and merges a change request.
115+
116+
In order to proceed. The user must rebase their change request to incorporate the latest changes into their own change request. A prompt tells the user what to do.

src/lib/navigation.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,6 @@ export const navigation: Navigation[] = [
341341
links: [
342342
{
343343
title: 'Query Examples',
344-
href: '/docs/woql-query-examples',
345344
links: [
346345
{
347346
title: 'Customer Data Processing',

0 commit comments

Comments
 (0)