[pve-devel] [PATCH docs 1/9] Rewrite Getting Help

[Thomas Lamprecht]

On 10.09.19 11:21, Aaron Lauterer wrote:
> Polished phrasing
> 

in general, I wouldn't call it rewrite, maybe rather reword, as the
information should not change, at least not become less than now.

> Signed-off-by: Aaron Lauterer <a.lauterer at proxmox.com>
> ---
>  getting-help.adoc | 42 ++++++++++++++++++++----------------------
>  1 file changed, 20 insertions(+), 22 deletions(-)
> 
> diff --git a/getting-help.adoc b/getting-help.adoc
> index 850d7a3..49d9085 100644
> --- a/getting-help.adoc
> +++ b/getting-help.adoc
> @@ -16,45 +16,43 @@ documentation with user contributed content.
>  Community Support Forum
>  ~~~~~~~~~~~~~~~~~~~~~~~
>  
> -{pve} itself is fully open source, so we always encourage our users to

IMO, it can has some value to note that we're not only open-source in the
sense of "here are the repos, but contributing/discussion discouraged"
but that thought-out discussion and contributions are in fact very encouraged.

I guess that you eliminated this as in 1.8, the section above, a bulletin point
is "Open source software", but IMO this are two different things. Maybe it fits
not in exactly this sub-point, but somewhere in 1.9 it could fit.

> -discuss and share their knowledge using the {forum}. The forum is fully
> -moderated by the Proxmox support team, and has a quite large user base
> -around the whole world. Needless to say that such a large forum is a
> +We always encourage our users to discuss and share their knowledge using the
> +{forum}. The forum is moderated by the Proxmox support team. The large user base
> +is spread out all over the world. Needless to say that such a large forum is a
>  great place to get information.
>  
>  Mailing Lists
>  ~~~~~~~~~~~~~
>  
> -This is a fast way to communicate via email with the Proxmox VE
> -community
> +This is a fast way to communicate via email with the Proxmox VE community

above does not change anything? IMO, the 80cc limit could've been done
in a separate patch. I could enforce and push this out directly on all
docs - please coordinate such changes, which do not change any content itself
with me, or someone else able and willing to do it.

That'd separate actual changes from "no-op" changes and make review much
easier, IMO.

>  
>  * Mailing list for users:
> -  http://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-user[PVE User
> -  List]
> +  http://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-user[PVE User  List]
>  
>  The primary communication channel for developers is:
>  
> -* Mailing list for developer:
> -  http://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-devel[PVE
> -  development discussion]
> +* Mailing list for developers:
> +  http://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-devel[PVE  development
> +  discussion]
>  
>  
>  Commercial Support
>  ~~~~~~~~~~~~~~~~~~
>  
> -{proxmoxGmbh} also offers commercial 
> -https://www.proxmox.com/en/proxmox-ve/pricing[{pve} Subscription Service
> -Plans]. System Administrators with a standard subscription plan can access a 
> -dedicated support portal with guaranteed response time, where {pve}
> -developers help them should an issue appear.
> -Please contact the mailto:office at proxmox.com[Proxmox sales
> -team] for more information or volume discounts.
> +{proxmoxGmbh} also offers enterprise support available as
> +https://www.proxmox.com/en/proxmox-ve/pricing[{pve} Subscription Service Plans].
> +All users with a subscription get access to the {pve} Enterprise Repository,

"Enterprise Repository" could maybe link to the sysadmin pve-package-repos.adoc
"{pve} Enterprise Repository" section?

> +and--with a Basic, Standard or Premium subscription--also to the Proxmox

space around hyphens?

> +Customer Portal. The customer portal provides help and support with guaranteed
> +response times from the {pve} developers.
> +
> +For more information, please contact

maybe?:
For volume discounts, or more information in general, please contact:

> +mailto:office at proxmox.com[office at proxmox.com].
>  
>  
>  Bug Tracker
>  ~~~~~~~~~~~
>  
> -We also run a public bug tracker at
> -https://bugzilla.proxmox.com. If you ever detect an issue, you can
> -file a bug report there. This makes it easy to track its status, and
> -you will get notified as soon as the problem is fixed.
> +{pve} runs a public bug tracker at https://bugzilla.proxmox.com. If an issue

No, {pve} does not runs the bug tracker ;)

Proxmox does, for all it's projects, which are for now PMG and PVE.

> +appears, file your bug report there. The bug tracker helps to keep track of the
> +bug and will send a notification once the issue has been solved.

it's not only bugs, there are enhancement (mostly feature) request tracked
and covered too. The "issues" from the original text was a bit more ambiguous,
albeit not too ideal either.