pfSense Gold Subscription

Author Topic: Wiki Updates / Style Guidelines  (Read 4884 times)

0 Members and 1 Guest are viewing this topic.

Offline jimp

  • Administrator
  • Hero Member
  • *****
  • Posts: 21312
  • Karma: +1423/-26
    • View Profile
Wiki Updates / Style Guidelines
« on: January 19, 2015, 01:07:06 pm »
Over the last few months I have worked through nearly every article in on our documentation wiki, https://doc.pfsense.org/ , editing for content, consistency, formatting, grammar, and so on.

Some articles have been updated for 2.2 (or at least 2.1.5), and some really old information was removed/cleaned up if it was no longer needed. A few things were rearranged, and some longer articles have been split up into smaller chunks. Quite a few new articles have also been added and there are more on the way.

Due to the large amount of work that has been put into cleaning up the Wiki and making corrections, the following is very important:

If you currently have an account to edit articles on the documentation wiki, please review the style and content guidelines before making any future edits to ensure that all articles continue to be of high quality and reflect well on the project.

Wiki Style Guide - https://doc.pfsense.org/index.php/Wiki_Style_Guide
Please read this entire article and follow the rules on the page. They are fairly simple guidelines but make a big difference in how articles look and read. Things like making sure "pfSense" is always properly capitalized, never addressing the user ("you", "your", etc.) and so on.

Quality Guidelines - https://doc.pfsense.org/index.php/Quality_guidelines
This article covers what should and should not be found in articles.

Templates - https://doc.pfsense.org/index.php/Template
Handy templates to add to articles to improve their appearance or make certain tasks easier.

Articles that do not follow the style and quality guidelines may be edited, removed, or flagged for cleanup.

If you notice an article that has a mistake or is in need of some other correction, bring it to our attention.
Need help fast? Commercial Support!

Co-Author of pfSense: The Definitive Guide. - Check the Doc Wiki for FAQs.

Do not PM for help!

Offline johnpoz

  • Hero Member
  • *****
  • Posts: 14299
  • Karma: +1331/-194
  • Not a pfSense employee, they cannot fire me...
    • View Profile
Re: Wiki Updates / Style Guidelines
« Reply #1 on: January 20, 2015, 08:45:51 am »
Will take a look see, thanks!
- An intelligent man is sometimes forced to be drunk to spend time with his fools.
- Please don't PM me for personal help
- if you want to say thanks applaud or https://www.freebsdfoundation.org/donate/
1x SG-2440 2.3.4_p1 (work)
1x 2.4.2-RELEASE on VM esxi 6.5 (home)

Offline biggsy

  • Hero Member
  • *****
  • Posts: 635
  • Karma: +16/-0
    • View Profile
Re: Wiki Updates / Style Guidelines
« Reply #2 on: January 21, 2015, 01:00:12 am »
Thanks, jimp. 

The style guide and templates are a great idea.

I did think a lot about which way to go regarding the use of the first and second person, etc.  There didn't seem to be much in the way of rules, so I just kept going in the hope of actually finishing my one and only contribution, while trying to figure out mediawiki formatting  ::).

I'll try to fix the screen shots (and maybe rework the first person stuff, as well)  in the very near future.

Edit: At least you didn't insist on pfSense  :)
« Last Edit: January 21, 2015, 01:16:04 am by biggsy »

Offline Derelict

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 9098
  • Karma: +1037/-307
    • View Profile
Re: Wiki Updates / Style Guidelines
« Reply #3 on: January 21, 2015, 01:28:12 am »
I've been trying to use them here, too.  I particularly like the italics for user entered content.  Beats using quotes.  (Do I enter the quotes or not?)
Las Vegas, Nevada, USA
Use this diagram to describe your issue.
The pfSense Book is now available for just $24.70!
Do Not PM For Help! NO_WAN_EGRESSTM

Offline jimp

  • Administrator
  • Hero Member
  • *****
  • Posts: 21312
  • Karma: +1423/-26
    • View Profile
Re: Wiki Updates / Style Guidelines
« Reply #4 on: January 21, 2015, 06:45:24 am »
The style guide and templates are a great idea.

The style guide is new but the templates have always been there (most of them, anyhow) -- funny thing though, even I had no idea that Templates page existed until I stumbled across it during this batch of updates :-)

I did think a lot about which way to go regarding the use of the first and second person, etc.  There didn't seem to be much in the way of rules, so I just kept going in the hope of actually finishing my one and only contribution, while trying to figure out mediawiki formatting  ::).

If you click "edit" on the style guide page the formatting is all there to see, which should be a handy reference for everyone to have in one spot.

I'll try to fix the screen shots (and maybe rework the first person stuff, as well)  in the very near future.

I fixed the wording/language on that page already, I think it just needs new screen shots to match the current wan=em0 lan=em1 recommendation.
Need help fast? Commercial Support!

Co-Author of pfSense: The Definitive Guide. - Check the Doc Wiki for FAQs.

Do not PM for help!

Offline jimp

  • Administrator
  • Hero Member
  • *****
  • Posts: 21312
  • Karma: +1423/-26
    • View Profile
Re: Wiki Updates / Style Guidelines
« Reply #5 on: January 21, 2015, 06:48:33 am »
I've been trying to use them here, too.  I particularly like the italics for user entered content.  Beats using quotes.  (Do I enter the quotes or not?)

Much of this was inspired by how we code the book in docbook. There aren't direct equivalents in mediawiki for most things like <replaceable> or <userinput> but we can use similar concepts. Along with being much easier to follow, It helps the book and wiki look more consistent.

And it definitely beats the ambiguous nature of quotes, so we don't have to constantly say things such as:  Enter "foo" (without quotes)
Need help fast? Commercial Support!

Co-Author of pfSense: The Definitive Guide. - Check the Doc Wiki for FAQs.

Do not PM for help!

Offline stephenw10

  • Administrator
  • Hero Member
  • *****
  • Posts: 11885
  • Karma: +461/-15
    • View Profile
Re: Wiki Updates / Style Guidelines
« Reply #6 on: January 21, 2015, 07:51:46 am »
This a great step forward in documentation. There are some things in the style guide that would not have chosen to do but in the end having some consistency is much better.
I have to say that reading through the list and comparing it to only page I contributed did seem like a check list of mistakes. Time for some editing.  ::)

My only comment here might be that the first time I went to the Writing_Disk_Images page after if had been updated I completely missed the [Expand] buttons and ended up thinking there was actually less information there. Perhaps they could be enhanced somehow?

Steve

Offline jimp

  • Administrator
  • Hero Member
  • *****
  • Posts: 21312
  • Karma: +1423/-26
    • View Profile
Re: Wiki Updates / Style Guidelines
« Reply #7 on: January 21, 2015, 08:21:06 am »
This a great step forward in documentation. There are some things in the style guide that would not have chosen to do but in the end having some consistency is much better.

Such as? Always open to suggestions.

I have to say that reading through the list and comparing it to only page I contributed did seem like a check list of mistakes. Time for some editing.  ::)

I'm the biggest offender of all, I started the style guide while correcting things I'd done over the last 6+ years so I'd have a list of things to check/look out for. It was a lot of work but I think there are only a single digit number of articles left that may not quite conform.

My only comment here might be that the first time I went to the Writing_Disk_Images page after if had been updated I completely missed the [Expand] buttons and ended up thinking there was actually less information there. Perhaps they could be enhanced somehow?

That would have to be changed in the CSS, I think. There may be other classes/styles that could be added which already exist. I've tried using some extra bits in the style tag but nothing seemed to help that. Suggestions welcome. After 2.2-RELEASE I can bug one of our web devs about it.
Need help fast? Commercial Support!

Co-Author of pfSense: The Definitive Guide. - Check the Doc Wiki for FAQs.

Do not PM for help!

Offline stephenw10

  • Administrator
  • Hero Member
  • *****
  • Posts: 11885
  • Karma: +461/-15
    • View Profile
Re: Wiki Updates / Style Guidelines
« Reply #8 on: January 21, 2015, 09:24:09 am »
Such as? Always open to suggestions.

Well off hand I have always used the following notation when referring to a page in the webgui:

System: Advanced: Networking:

Only because that's how it appears in the webgui when you get to the page. However using:

System > Advanced, Networking tab

implies navigating the menus in order more correctly. It's far better to have consistency even it's not everyones preferred option, as long it's not actually incorrect in some way.

Steve

Offline jimp

  • Administrator
  • Hero Member
  • *****
  • Posts: 21312
  • Karma: +1423/-26
    • View Profile
Re: Wiki Updates / Style Guidelines
« Reply #9 on: January 21, 2015, 09:43:07 am »
Ah, yes, the style I used focuses on the navigation actions taken by the user. The page titles don't always line up or may have longer titles. The page titles are more free-form and less restricted by space than the menus, but when instructing the user what to click or where to go, it's preferred to list the items they should be clicking on.

So the page titles are more informative, but less useful as a navigation aid.
Need help fast? Commercial Support!

Co-Author of pfSense: The Definitive Guide. - Check the Doc Wiki for FAQs.

Do not PM for help!