Page MenuHomeFreeBSD

Vale introduction in FDP
ClosedPublic

Authored by bofh on Nov 13 2022, 3:22 PM.
Tags
Referenced Files
Unknown Object (File)
Sun, Jan 29, 1:17 AM
Unknown Object (File)
Jan 7 2023, 8:13 AM
Subscribers

Details

Summary

Introduction of vale in the fdp-primer. The patch describes about the current rules and howto use vale from command line or editors.

@salvadore as you are checking the stuffs with vim please feel free to comment on the usages or rules.

Test Plan

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

bofh requested review of this revision.Nov 13 2022, 3:22 PM
bofh updated this revision to Diff 113054.
bofh created this revision.
This revision is now accepted and ready to land.Nov 14 2022, 8:37 AM

Oops. Looks like my commit missed the review.

Reword. This would have benefitted from much wider review, from inception to commit. Please allow more time for these wide-ranging changes, and perhaps invite feedback on the doc@ mailing list.

documentation/content/en/books/fdp-primer/writing-style/_index.adoc
259

Have

259

and the website,

261

in a

261

, or integrated into your editor of choice

263

and their respective

306

the

306

vendor

306

company

306

how to write

306

According

306

copyright

306

the

307

Similarly,

307

be respectful of other brands'

307

and one should write

308

either "the file", or ""

315

Some

315

resuming

316

author

318

aims to avoid

319

use

319

I don't know what this is supposed to mean.

320

as a weasel word,

322

use of conscious language

324

Attempts to avoid whitespace at the end of lines.

328

notice

330

en_GB

331

en_GB

335

future

335

Who decides?

340

within an editor

341

by typing

349

on the command line

351

Assuming that the doc repository...

351

, the

351

will run vale with the project's configuration

362

A better way

362

Not what sure what this is trying to say.

369

configuration

370

An example configuration

In D37381#849798, @ceri wrote:

Reword. This would have benefitted from much wider review, from inception to commit. Please allow more time for these wide-ranging changes, and perhaps invite feedback on the doc@ mailing list.

Thanks for the feedbacks. I will look into it after I finish preparing the Emacs configuration part as that is more trivial than ever at this point.

Updates according to feedback from @ceri

bofh marked 16 inline comments as done and an inline comment as not done.
bofh marked 21 inline comments as done.Nov 14 2022, 11:57 PM
bofh added inline comments.
documentation/content/en/books/fdp-primer/writing-style/_index.adoc
261

I am not sure whether if we are allowed to use any of "you/your/they/their"

319

Was a typo. Let me know if it is clear now.

335

Let me know if the scenario is well described or requires more clarification.

362

Tried to elaborate more

About the use of "you".

documentation/content/en/books/fdp-primer/writing-style/_index.adoc
261

I am not sure whether if we are allowed to use any of "you/your/they/their"

We're discouraging the use of "you" in the documentation.

"into an editor of choice" solves this...