Don't show the revision log message on creation of content, media, etc.

The attached patch makes a very simple change to the showRevisionUi() method on content entity forms. It checks to make sure that this is NOT a new entity in order to display the revision field.

Note that this patch works for nodes, but doesn't seem to work for media.

Seems like it's working too for media based on the test fails.

For the record, I'm fairly sure this was done like this on purpose, what we've done is to hide the checkbox and keep this. The first revision can still have a comment.

> the visual prominence is overwhelming and takes attention away from the task at hand.

Don't disagree with that, wondering how that looks in Claro? Also, if we were to apply the sidebar layout of the node form to to other forms then that might help with that?

I found a much more effective change. It simply hides the revision information on new entity forms. This means it can be undone by a form alter (vs. an unset).

This helps to provide a cleaner UX for authors, it is easily reversible by contrib, and works for nodes as well as media

Adding a few before/after screenshots.

Fixed filed tests from #10

I've tested the patch in #13 and can confirm that the revision log message is not shown when creating a new block, node, or media item and it is shown when editing a block, node, or media item.

Verified and tested by applying patch#13.It looks good to me.Moving it to RTBC.

Steps to test -
1. Go to the admin site.
2. Go to /admin/content -> Click on Create content type.
3. Verify if revision log is available or not.
4. Go to /admin/content/media ->Click on Create media.
5. Verify if revision log is available or not.
6. Go to admin/structure/block/block-content -> Click on Create block.
7. Verify if revision log is available or not.

Content Type -

Block -

Media -

1. +++ b/core/lib/Drupal/Core/Entity/ContentEntityForm.php
   @@ -130,6 +130,11 @@ public function form(array $form, FormStateInterface $form_state) {
   +    // Hide the revision log field on new entity forms.
   +    if ($this->entity->isNew()) {
   +      $form['revision_information']['#access'] = FALSE;
   +    }
   

   This is better written as

   // Hide the revision log field on new entity forms.
   $form['revision_information']['#access'] = !$this->entity->isNew();
   

   I.e. without the if. This is so the form keys don't change. Makes things simpler for alters.

2. I think there is also some interesting code in prepareEntity()
   

     /**
      * {@inheritdoc}
      */
     protected function prepareEntity() {
       parent::prepareEntity();
   
       // Hide the current revision log message in UI.
       if ($this->showRevisionUi() && !$this->entity->isNew() && $this->entity instanceof RevisionLogInterface) {
         $this->entity->setRevisionLogMessage(NULL);
       }
     }
   

   it makes me wonder if the correct fix is for \Drupal\Core\Entity\ContentEntityForm::showRevisionUi() to be

   return !$this->entity->isNew()  && $this->entity->getEntityType()->showRevisionUi();
   

3. One thing I'm wondering about is what will the impact of the change be on a site where someone has altered the revision_log_message to be required. I've test locally - yeah we need to detect if it is required and show it in those cases.

Hi @alexpott
Updated point 1 please review.

I think we need an explicit test plus #18.2 and #18.3 probably should be addressed.

+1 for getting this changed, it would be a big improvement.

@alexpott I tried to address the points #18.2 and #18.3 on this new patch.

Regarding the #18.2 I tried to use

return !$this->entity->isNew()  && $this->entity->getEntityType()->showRevisionUi();

instead of the approach on the patch, but it had the opposite desired effect. I discovered that in some cases the default code already hides the revision field on the creation of new content types, and by changing this return line the revision field starts to appear. (see on "..._alternative_code" pictures).

About #18.3 I added the additional validation. I wasn't able to test with required revision fields, but at least this field isn't showing when, for example, I try to create a new block.

One concern that I got when working on this issue is about the code removal from PagePreviewTest::testPagePreviewWithRevisions. The name of the test refers to testing the page "with revisions" so removing the assertion that checks the revision just to make it pass doesn't sound as the right approach. Maybe rebuild the test, or remove it entirely an replace with a more specific one? I'm not an expert so I don't know what is the right thing to do.

Keeping on needs work as it still needs dedicated tests.

Addressing the test fails.

Sorry, I didn't mean to change the status.
It still needs work as we still need dedicated tests.

Im going to give it a try with the tests

Any luck with the tests, Johnny Santos, or should this be un-assigned?

+1 to this, very unexpected to have this shown on new entity forms