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

Update and rename security.adoc to security-policy.adoc #1665

Closed
wants to merge 1 commit into from

Conversation

rolfedh
Copy link
Contributor

@rolfedh rolfedh commented Mar 22, 2023

Fixes: #1664

@rolfedh
Copy link
Contributor Author

rolfedh commented Mar 22, 2023

@maxandersen @sberyozkin PTAL

@rolfedh
Copy link
Contributor Author

rolfedh commented Mar 23, 2023

@gsmet Please review and merge.
cc: @sberyozkin

@rolfedh rolfedh force-pushed the rename-security.adoc branch 2 times, most recently from 6fab40c to 9e35e19 Compare March 28, 2023 14:42
@rolfedh
Copy link
Contributor Author

rolfedh commented Mar 28, 2023

@gsmet Updated and ready to merge.
cc: @sberyozkin

@sberyozkin
Copy link
Member

Hi @gsmet Can you please look at this PR ?

@rolfedh
Copy link
Contributor Author

rolfedh commented Jun 13, 2023

/assign @gsmet

Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm really not sure this change will change anything for Google searchability of the security guide... and it's breaking any external link to our security page which is a no-no.

We at the minimum need to put a redirect in place.

But even so, I'm not especially excited about it.

@maxandersen @insectengine WDYT?

@rolfedh rolfedh force-pushed the rename-security.adoc branch 2 times, most recently from f080a62 to dba2ca6 Compare June 14, 2023 10:54
@rolfedh
Copy link
Contributor Author

rolfedh commented Jun 14, 2023

We at the minimum need to put a redirect in place.

Thanks. I've just added _redirects/security.md to address this.
Please see #1664 for a fuller discussion of the issue, including the original request from, I believe, @sberyozkin.

@github-actions
Copy link

github-actions bot commented Jun 14, 2023

🙈 The PR is closed and the preview is expired.

@maxandersen
Copy link
Member

I've read but still I don't grok why changing this url is supposed to help?

It is a good thing it's just quarkus.io/security.

Why require the longer harder to remember/copy/read quarkus.io/security-policy url?

@maxandersen
Copy link
Member

Changing the title I can buy or at least add security policy in top part of message but the url and redirect is a -1 from me.

@rolfedh
Copy link
Contributor Author

rolfedh commented Jun 14, 2023

I've read but still I don't grok why changing this url is supposed to help?

An SEO best practice is to align the file name and the title of the document.

image

@maxandersen
Copy link
Member

thats fine but lets please not use long winded "policy" names in URLs. URLs like these are to be remembered, typed and understood easily.

quarkus.io/security is easy to remember, easy to type and most understand that page has stuff to do around quarkus security - let me read that .

quarkus.io/security-policy is not easy to remember, hard to type (is it with a or without a dash ? is it policy to not policy?, _ and if I see security-policy it is not a page I or many I can think of will go read :)z

and in addition quarkus.io/security is short and descriptive and use same keywords as in title and in page so I think we are covered.

@holly-cummins
Copy link
Contributor

Piling in here ... Based on my highly representative sample of one, I can confirm what Max says. A page named http://quarkus.io/security-policy is one I'd actively try to avoid reading. 😂

@rolfedh
Copy link
Contributor Author

rolfedh commented Jun 16, 2023

Absolutely, I'm happy we've discussed this and come to a consensus. My aim was to put into action what I thought Sergey was suggesting. As it stands, we've only agreed on revising the title. So, I'll remove the changes for the redirect, altering the file name, and updating the links. The PR should be ready to merge shortly.

@rolfedh rolfedh force-pushed the rename-security.adoc branch from dba2ca6 to fe6fd3a Compare June 16, 2023 14:12
@rolfedh
Copy link
Contributor Author

rolfedh commented Jun 16, 2023

I'll make a parallel change to https://github.com/quarkusio/quarkus/blob/master/SECURITY.md as well.

@rolfedh
Copy link
Contributor Author

rolfedh commented Jun 16, 2023

@maxandersen @holly-cummins: Based on your feedback, I've retitled the security policy page to "Security policy" and removed everything else. Please approve so we can get this merged.

@rolfedh
Copy link
Contributor Author

rolfedh commented Jun 16, 2023

I'll make a parallel change to https://github.com/quarkusio/quarkus/blob/master/SECURITY.md as well.

  • Actually, quarkusio/quarkus/blob/master/SECURITY.md states that The canonical version of this document is hosted on the Quarkus website at [Quarkus security](https://quarkus.io/security/).
  • In other words, the file in this PR is the only one that needs to be updated.

@rolfedh
Copy link
Contributor Author

rolfedh commented Jul 20, 2023

@gsmet The result of our conversations is a simple change to the title. I believe this is ready to merge now.

@rolfedh rolfedh requested a review from gsmet July 20, 2023 12:45
@rolfedh rolfedh closed this Aug 29, 2023
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.

Update Security Policy document to improve Quarkus Security search results
5 participants