Skip to content

Conversation

@gnito-org
Copy link
Contributor

@gnito-org gnito-org commented Sep 17, 2021

I thought I'd make a first pass at modifying security.rst for 5.4. It's far from perfect, but I think it's a solid base to work from.

I tried to adapt my software to 5.4 using the existing security.rst and found it a frustrating process. Hence the effort to rewrite some sections.

I thought I'd make a first pass at modifying security.rst for 5.4. It's far from perfect, but I think it's a solid base to work from.
@gnito-org
Copy link
Contributor Author

Is there any Linux tool or app, or any other way, that can show an actual preview of the final page?

The preview function of PHPStorm's RestrcuturedText plugin is broken.

ReText on Linux is useless for previewing because it freaks out about broken links.

@gnito-org
Copy link
Contributor Author

I'm not sure how to fix the CI / Code Blocks errors because it does not tell me the line numbers where it found the errors.

@wouterj
Copy link
Member

wouterj commented Sep 18, 2021

Hi @gnito-org. I'm really very sorry, but work on this has already started some time ago in #15503 . We're rewriting all security docs as, like you said, they are a bit frustrating as a whole (not only because they are outdated, but also because the sections and scattered small guide articles aren't up to standard anymore). We hope to finish the work shortly.
I'll have a close look at your changes to see if I can include some of them in the rewrite, so your work isn't completely at a loss.

In the future, I recommend you first have a look at the issues/PRs to see if work has already started or, like I recommended in the GitHub discussions, ask a doc team member about it before starting such a big work.

@wouterj wouterj closed this Sep 18, 2021
@gnito-org
Copy link
Contributor Author

@wouterj No problem. Time spent was an education fee, and I learned a lot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants