Summary

Adding custom message in banner

Review Request #8824 — Created March 18, 2017 and submitted Jan. 10, 2018, 2:25 p.m.

Information

Owner

khp

Repository

Review Board

Branch

master

Bugs

Depends On

~~8648~~, ~~8657~~, ~~8812~~, ~~8810~~, ~~8811~~

Blocks

8861, 8847

Reviewers

Groups

reviewboard, students

People

Description

Read-only mode is a feature that can be enabled by the admin to disable
most backend changes by regular users. This commit adds a custom
message for the banner when in read-only mode. The message can be
optionally added through the admin panel right under where the admin
would enable/disable read-only mode.

Testing Done

Ran js-tests - passed
Ran python tests - most passed, some failures fixed in future commit
Checked changing value in admin panel reflects in banner

Files

Issues

Description	From	Last Updated
Mind wrapping your description & testing done at 72 characters?	brennie	April 6, 2017, 2 a.m.
Care to add the keys to this?	brennie	March 29, 2017, 11:45 a.m.
How about "A custom message displayed when the site is in read-only mode."	brennie	March 29, 2017, 11:46 a.m.
<b> is deprecated. Since you're making this a header, how about just using h2 (since its not the main header …	brennie	March 29, 2017, 11:52 a.m.
"dictionary will"	brennie	April 6, 2017, 1:59 a.m.
:py:class:`bool`	brennie	April 6, 2017, 2 a.m.
Blank line between these.	brennie	April 6, 2017, 2 a.m.
string is not a type, you mean unicode. Also, this won't auto link to the correct type. Use: :py:class:`unicode`	brennie	April 6, 2017, 2 a.m.

Tool: Pyflakes
Processed Files:
    reviewboard/admin/context_processors.py
    reviewboard/admin/forms.py

Ignored Files:
    reviewboard/static/rb/css/pages/base.less
    reviewboard/static/rb/css/defs.less
    reviewboard/templates/base.html



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/admin/context_processors.py
    reviewboard/admin/forms.py

Ignored Files:
    reviewboard/static/rb/css/pages/base.less
    reviewboard/static/rb/css/defs.less
    reviewboard/templates/base.html

reviewboard/admin/context_processors.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Care to add the keys to this?
```
reviewboard/admin/forms.py (Diff revision 1)
The issue has been resolved. Show all issues
```
How about "A custom message displayed when the site is in read-only mode."
```

reviewboard/templates/base.html (Diff revision 1)

The issue has been resolved. Show all issues

<b> is deprecated. Since you're making this a header, how about just using h2 (since its not the main header of the page, which is what h1 should usually be used for) instead of <span><b>

khp March 29, 2017, 11:55 a.m.

Wow, I did not know that! I couldn't get it to look good with h2 since it introduces a break-line, so I just styled the span to have a font-weight: bold; attribute.

brennie March 30, 2017, 1:34 a.m.

You can do h2 { display: inline; } to not introduce a line-break.

Diff:

Revision 2 (+34 -5)

Show changes

	reviewboard/admin/context_processors.py
	reviewboard/admin/forms.py
	reviewboard/static/rb/css/defs.less
	reviewboard/static/rb/css/pages/base.less
	reviewboard/templates/base.html

Checks run (2 succeeded, 1 failed with error)

JSHint passed.

PEP8 Style Checker internal error.

Pyflakes passed.

Summary:: [WIP] Read-Only Mode: Looking into custom message in banner
Read-Only Mode: Adding custom message in banner
Description:: ~
Looking into adding a custom message for the banner when in read-only mode. An alternative may be to add a datetime field in admin panel and generate a message based on when the read-only mode should be over by.
~
Read-only mode is a feature that can be enabled by the admin to disable most backend changes by regular users. This commit adds a custom message for the banner when in read-only mode. The message can be optionally added through the admin panel right under where the admin would enable/disable read-only mode.
Testing Done:: +
Ran js-tests - passed
+ Ran python tests - most passed, some failures fixed in future commit
+ Checked changing value in admin panel reflects in banner
Depends On:: ~~8648 - Add siteconfig var and button for read-only mode~~
~~8657 - Respond to API requests with 503 when read-only mode~~
~~8810 - Disable front-end features for read-only mode~~
~~8811 - Redirect some views in read-only mode, hide links to these views~~
~~8812 - Add read-only banner under navbar~~

Summary:: Read-Only Mode: Adding custom message in banner
Adding custom message in banner

Ship it!

```
Minor nitpicks. Looks good to me!
```
reviewboard/admin/context_processors.py (Diff revision 2)
The issue has been resolved. Show all issues
```
"dictionary will"
```
reviewboard/admin/context_processors.py (Diff revision 2)
The issue has been resolved. Show all issues
```
:py:class:`bool`
```
reviewboard/admin/context_processors.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Blank line between these.
```

reviewboard/admin/context_processors.py (Diff revision 2)

The issue has been resolved. Show all issues

string is not a type, you mean unicode.

Also, this won't auto link to the correct type. Use:

:py:class:`unicode`

The issue has been resolved. Show all issues

Mind wrapping your description & testing done at 72 characters?

Change Summary:

Update according to comments + fix description line wrapping

Description:

~		Read-only mode is a feature that can be enabled by the admin to disable most backend changes by regular users. This commit adds a custom message for the banner when in read-only mode. The message can be optionally added through the admin panel right under where the admin would enable/disable read-only mode.
	~	Read-only mode is a feature that can be enabled by the admin to disable
	+	most backend changes by regular users. This commit adds a custom
	+	message for the banner when in read-only mode. The message can be
	+	optionally added through the admin panel right under where the admin
	+	would enable/disable read-only mode.

Diff:

Revision 3 (+35 -5)

Show changes

	reviewboard/admin/context_processors.py
	reviewboard/admin/forms.py
	reviewboard/static/rb/css/defs.less
	reviewboard/static/rb/css/pages/base.less
	reviewboard/templates/base.html

Checks run (2 succeeded, 1 failed with error)

JSHint passed.

PEP8 Style Checker internal error.

Pyflakes passed.

Status:: Completed
Change Summary:: Pushed to release-4.0.x (5f7b06b)

~		Looking into adding a custom message for the banner when in read-only mode. An alternative may be to add a datetime field in admin panel and generate a message based on when the read-only mode should be over by.
	~	Read-only mode is a feature that can be enabled by the admin to disable most backend changes by regular users. This commit adds a custom message for the banner when in read-only mode. The message can be optionally added through the admin panel right under where the admin would enable/disable read-only mode.

	+	Ran js-tests - passed
	+	Ran python tests - most passed, some failures fixed in future commit
	+	Checked changing value in admin panel reflects in banner