Skip to content

Clarify FAQ and add 'abbr' tags - #39

Merged
EdOverflow merged 2 commits into
securitytxt:masterfrom
joker314:feat/clarify-faq
Nov 3, 2019
Merged

EdOverflow merged 2 commits into
securitytxt:masterfrom
joker314:feat/clarify-faq

Conversation

@joker314

@joker314 joker314 commented May 3, 2019

Copy link
Copy Markdown
Contributor

Resolves #38

I'm not completely happy with the wording so that's something to review.

  • Add <abbr> tags around all the references to "RFC"
  • Add a new FAQ section called "Are there any settings I should apply to the file?" (the answer is: serve over HTTPS, set MIME type to text/plain)
  • Clarify that you can place the security.txt file at the root of websites and code repositories

Here is what the changes look like:

The abbreviations 'RFC' are underlined with a dotted line to show that you can however over them to see the full name. There are also changes to the content of the answers to the questions discussed above.

@nightwatchcyber

Copy link
Copy Markdown
Contributor

I think that looks fine to me, although we should consider making the language around the root directory and HTTPS stronger.

@joker314

Copy link
Copy Markdown
Contributor Author

@nightwatchcyber I've changed "should" to "must" for the HTTPS, especially because the Internet draft has done the same.

@EdOverflow
EdOverflow merged commit d2de11d into securitytxt:master Nov 3, 2019
@joker314
joker314 deleted the feat/clarify-faq branch November 4, 2019 03:13
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.

Ammendments to the FAQ

3 participants