Recent Topics

How can someone help with documentation?

Started by on Feb 18, 2019 – Contents updated: Mar 31, 2019

Feb 18, 2019 23:28    

I realize you can't just allow people to have access to the manual with create/edit privileges but according to this page, https://b2evolution.net/man/guidelines-for-manual-pages, you do invite contributions. What would be the process of contributing? Where do we go and in what format would we submit? One item is up to date screenshots and verbiage. The comment section of the man pages doesn't allow the markup requested on that guideline page and I don't know if you want the comment section cluttered up with such things.

Feb 21, 2019 16:52

The guidelines page is still here from a time when everybody could edit the man pages (we have a rollback feature if needed).

But the problem is that people with best intentions wrote things that were deeply incorrect, hidden in heartfelt tutorials. Sometimes we only found out long after.

We figured it makes more sense to have people ask for missing info rather than trying to work with inaccurate info.

We are also about to roll out a "proposed change" feature to man pages.

In the meantime you are welcome to post comments on the pages. We will manually integrate them into the pages. Please let us know which renderers are most critically missing in the comments section.

Thanks.

Feb 21, 2019 18:12

@fplanque wrote earlier:

. . . you are welcome to post comments on the pages. We will manually integrate them into the pages. . . .
Thanks.

As has been the case, still seems like the sensible thing to do

Feb 21, 2019 19:21

Oh I fully understand about not allowing edit capabilities. As far as the renderers, I was just going by what I saw in the guidelines but it really won't apply too much for merely commenting adding screenshots, asking for more info, making suggestions etc. I just saw 'please use wacko for headings' but that renderer isn't activated in the manual. That would apply more to someone writing and entire man page so it's probably not needed. I see Markdown headings so maybe that's what's being used now.

I just wanted to contribute when possible rather than hitting 50 man pages saying, "not enough info" or "outdated info" etc.

Feb 21, 2019 23:55

@poorboy2

I just wanted to contribute when possible rather than hitting 50 man pages saying, "not enough info" or "outdated info" etc.

I know your problem but

a) I've decided that if I can't be bothered to add constructive comments, other than as you infer "not enough info" or "outdated info" why should I want/expect others to do so.

b) I'm not paying for this service so I am more than grateful for the help offered in docs and forum.

Feb 27, 2019 23:57

It is helpful to comment on pages that are outdated or that have not enough info, so we know which ones to update in priority.

It is even more helpful if you can quote what is outdated and/or describe in a few words what info is missing.

Thanks.

Mar 06, 2019 01:14

The "proposed change" feature will be rolled out in b2evolution 6.11.0 or 6.11.1 and shortly thereafter on this site.

Mar 15, 2019 01:39

@amoun @poorboy2 @davidnewcomb I have given you permission to propose changes to the manual pages.

You can access it like this:

New "Propose change..." menu entry!

This is still a beta feature, so please screenshot any quirks. Thank you!

If all goes well, we will receive notifications whenever you propose a change, so we should be able to review/approve them quickly.

Thanks a lot for your help in keeping the manual up to date!

Anyone else interested, please let me know.

Mar 15, 2019 02:45

Wow! I was ok with just adding comments. Will have a looksee.

Hmm! ? there's no [Propose Change] on my browser ? Although there is an arrow there is no drop down?

Am I looking in the right place.

Mar 15, 2019 03:07

What I do have is on the forum is questionable,
I haven't seen this before, but it seems pretty innocuous now I've poked around.

Mar 15, 2019 13:06

Your screenshots are too cropped to be really useful.

Screenshot 1: you will get the "Propose change" only when you view a manual page. I don't know what you where looking at.

Screenshot 2: this is something you should see only when you have permission to edit the forum topic, presumably because you have posted it yourself. Is this correct? I can't see on what page you see this.

Wow! I was ok with just adding comments. Will have a looksee.

For typos for example, it's much easier to correct the original text than to explain where the typo is ;)

Mar 15, 2019 14:13

@fplanque wrote earlier:

Your screenshots are too cropped to be really useful.

Screenshot 1: you will get the "Propose change" only when you view a manual page. I don't know what you where looking at.

Yes I was checking too early on, whilst still in cat/subcat. I suppose because the link is not greyed out and highlights when hovered over I though it was actionable.

Screenshot 2: this is something you should see only when you have permission to edit the forum topic, presumably because you have posted it yourself. Is this correct? I can't see on what page you see this.

Yes you are right, I've just never noticed before :)

For typos for example, it's much easier to correct the original text than to explain where the typo is ;)

Yes all you said makes sense

All good

Thanks

Mar 15, 2019 14:45

Yes you are right, I've just never noticed before :)

It's not there by default. I enabled the evobar for people who may want to use the "Propose change" feature.

PS: yes we'll need to work on the greying out...

Mar 16, 2019 01:43

@amoun I validated your first proposed change. Please don't add markup like [s] to strike text, because if you do I need to manually delete it after you. If you delete text directly, the version history "diff" algo included in b2evo shows the text yo have deleted anyway.

Mar 30, 2019 21:39

I don't see any way to add images and I can't seem to link to a Docs page as it's not listed in the Short Links pop up. I also wanted to link to the demo but even though it shows up in that pop up, it tells me "No posts found for requested collection".


Proposed Change to
https://b2evolution.net/man/about-widgets


Think of widgets as little applications you can include throughout your website to make your website more appealing and interactive. Widgets can display calendars, social media updates, weather forecasts, recent comments, and all sorts of good stuff like that!

The bulk of a page in b2evolution is made up of widgets and content. Widgets are held in Containers(LINK https://b2evolution.net/man/container), the existence, location and size of which is dependent upon the skin being used on a given Collection. Aside from skins affecting containers and widgets, the type of content chosen for the front page(LINK https://b2evolution.net/man/collection-front-page-settings) also has an affect on what widgets and containers will show.

Below is a screenshot of the front page of Blog A of the be2vo demo site(LINK to Demo site) with the widgets highlighted using the Widgets menu item in the evobar.

As you can see above, we have a Header Container holding a Collection Title and Collection Tagline widget. In the Container on the right called Page Top, we have a Free Social Links widget. Below that are more Containers with other Widgets.

Here's the same page without widgets highlighted for a comparison. (Activating the Widgets highlight feature does change the layout of certain items, namely Widgets in the Menu Container in this case as the css that makes it a horizontal menu is not applied when widgets are highlighted.)


Here's said pop up that should have the Docs/Manual collection listed so we can cross link to topics. I don't know how the link to the demo would be handled. I just thought that if someone was checking out the Widgets manual page but hadn't installed b2evo yet, they could see the widgets highlight feature in action on the demo. It's a pretty nice feature.


Form is loading...

CMS software – This forum is powered by b2evolution CMS, a complete engine for your website.