salesagility / suitedocs Goto Github PK

Page with Issue

What is wrong, less clear, or missing

Guide is confusing when it comes to setting permissions. One line says apachegroup and another says www-data. Then the same a.b.c is used for more than one thing. How is anyone supposed to get it right?

Proposed fixes and/or additions

Our Home page needs to be edited so that every string is looking for a localized version.

See an example of these changes here:
81743e5

Note that there is currently a bug in our Theme that makes the translated home page look broken, but this shouldn't stop us from advancing this Issue here.

(I've reported that bug here matcornic/hugo-theme-learn#140)

All the other CTA's ("calls to action") in the Homepage need to get that {{ T "label" }} tag added, and the corresponding entry made on the en.tomlfile. Then the translators can add them also in other files likees.toml`. The commit I linked above should make this easy to understand, hopefully.

Page with Issue

Hi, we at gcoop some time ago start translating Userguide into spanish.

Do you think we can include this translation into this repo?

I think we are duplicating efforts in some way

https://docs.suitecrm.com/admin/installation-guide/3.upgrading/

Quote1 from the first paragraph:

There is currently no silent upgrade path available for SuiteCRM.

Quote2 from the upgrade considerations:

Use the Silent Upgrade method through the command line interface...

Page with Issue

https://docs.suitecrm.com/developer/vardefs/

What is wrong, less clear, or missing

In "Indices" area when you explain indices types, I think you must indicate if its possible include custom fields or not.

Proposed fixes and/or additions

And if it is possible you must indicate how to do that.

Below is a list of all of the sections that have screenshots that need updated:

• Managing User Accounts > Themes tab is no longer there
• User Interface > Advanced Module Search – There is no ‘Layout Options’ panel
• Campaign > Campaign ROI Tracking – ROI graph needs updated
• Sales > PDF Templates
• Sales > Generate Letter
• Workflow > Send Email – Record Email
• Workflow > First example WorkFlow
• Workflow > Process Audit
• Cases with Portal > Installation & Configuration
• Cases with Portal > Using AOP
• Events > Updated Delegate Status

Once the screenshots have been taken you can drop them in to the directory:

SuiteDocs > static > images > en > user

Feel free to change the image titles where appropriate too.

Page with Issue

http://docs.suitecrm.com/developer/

What is wrong, less clear, or missing

With a resolution of 1366x768 the sidebar is not scrolling to show all of the developer guide.

Proposed fixes and/or additions

This is just an idea for content:

There's a sticky post on the Forums which really belongs on the Documentation site:

https://suitecrm.com/suitecrm/forum/suitecrm-7-0-discussion/9087-how-to-use-the-resource-chart-functionality

It would be nice to bring this in one day, and then I could un-sticky the thread on the Forums. This is not urgent, of course.

English is the first language in the Documentation. It will get special treatment - among other things, SalesAgility will contribute large parts of it, and will update it along with the SuiteCRM software updates.

Then we might have other languages, this is meant to be multilingual, but we will start with just one "second language", to work on all technical issues this will raise, and only when we're comfortable with the structure we will move on to additional languages.

The most likely candidate would be Spanish or French.

Starting with Russian would make things really hard to follow for me, even if I know that the Russian SuiteCRM Community is big and vibrant...

We start with one language so we can try to develop the way we deal with the multiple files, see how the menus work, think how we handle missing files (when the other language is only incompletely translated), etc.

Page with Issue

On this page: https://docs.suitecrm.com/developer/api/api-4_1/

What is wrong, less clear, or missing

The link is broken:

For a full list of API methods and their arguments see Appendix B.

I unable to see module list

Proposed fixes and/or additions

From Security Suite (Groups).adoc

Quote1:

Shared Calendar - Hide Restricted
By default users can see when other users are busy on the Shared Calendar. Even if you doesn’t have rights to the meeting, call, etc. It will display on the calendar, but you cannot view more details unless you have rights to that specific calendar item. By setting this option you cannot see these items on the Shared Calendar; only items that you actually has rights to.

Quote2:

Groups Setup
There are 3 key steps to setting up Groups so that you work correctly....
You can use the Mass Assign on the List View to do this.

It would be nice to use Shared Calendar restriction and Group Mass Update, but now these features are not present in the actual SuiteCRM version.

I wrote a after_save logic hook in email module to create the leads but not able to create the leads in suitecrm 7.9.12

Page with Issue

What is wrong, less clear, or missing

Missing translation into spanish:
https://docs.suitecrm.com/user/introduction/

Proposed fixes and/or additions

Page with Issue

https://docs.suitecrm.com/user/

What is wrong, less clear, or missing

This is the main documentation page. It lists things like Core Modules and Advanced Modules, but not the Opportunities module.

Also, following the pattern where a link from this page to "Leads" goes to https://docs.suitecrm.com/user/core-modules/leads/, I checked to see if https://docs.suitecrm.com/user/core-modules/opportunities/ existed, and I got "Woops. Looks like this page doesn't exist ¯_(ツ)_/¯."

Proposed fixes and/or additions

Put the opportunity doc back in there. It seems that there was a recent migration of the doc, so the migration process should be reviewed to see if anything else was lost in translation.

Page with Issue

What is wrong, less clear, or missing

Proposed fixes and/or additions

When browsing a non-english version of the Docs site, the top menu is translated, but if you click on the links, you are taken to the English version of the site, even if the page you wanted exists on the translated site you were browsing.

The menu links here need to be made more intelligent:

https://github.com/salesagility/SuiteDocs/blob/master/layouts/partials/menu.html#L121

Basic styling and functionality of top menu.

Page with Issue

https://docs.suitecrm.com/developer/api/1.-api-4_1/

What is wrong, less clear, or missing

Proposed fixes and/or additions

It would be nice to easily copy from the examples without having to delete the line numbers 😃

• move the images into GitHub (done)
• import the text again and link the images
• break the text into chapters
• fix internal links

Split some sections into the Administrative Guide: how to install, how to migrate, how to upgrade, etc.

Page with Issue

all page

What is wrong, less clear, or missing

I was following the installation guide but after the installation which went correctly and hugo started I've got a white screen
page source is:

<pre>
</pre>

Proposed fixes and/or additions

Can I suggest this guide as an official Russian translation?

I would like to convert Russian RAPIRA application guide from DOCX to ADOC, but its contents are not translated from English verbatim (some sections are translated in more detail, with a lot of images and cross-references, the structure of the table of contents is slightly changed, etc.)

There is no problem with internal cross references, but when I try to add some references to another document, for example from _index.ru.adoc to User Interface.ru.adoc:
<<../User Interface.ru.adoc#Some section,Some section>>
I've got this wrong link

. . . /user/introduction/User%20Interface.ru.html#Some%20section

instead of

. . . /user/introduction/user-interface.ru/#_some_section

Upd: Now I use link: notation, although it's much less convenient.

Environment:
Debian 9.4
hugo 0.37
Asciidoctor 1.5.4

With the release of 7.10 there is a brand new REST API so the documentation will need to be updated as such!

We also need guidelines for the new features e.g. namespaces, loggers, etc.

http://jsonapi.org/format/1.0/

http://oauth2.thephpleague.com/

https://swagger.io/specification/

This should be pretty easy, I put it here as a reminder to myself...

Add FontAwesome <head> style reference:

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" />

Page with Issue

What is wrong, less clear, or missing

Proposed fixes and/or additions

This needs fixing.

The description of the following modules are not available in the English guide, but present in the Russian guide:

• PDF Templates / PDF-шаблоны
• Knowledge Base / База знаний
• Spots / Сводки
• Employees / Сотрудники
• Errors / Ошибки

Do you have a plan to add them (or part of them) into English user guide?
If so, how that files will be named and in which section they will be located?
Weight for each file?

Page with Issue

https://docs.suitecrm.com/admin/installation-guide/

What is wrong, less clear, or missing

See the latest release notes for SuiteCRM here. The Click "here" is not a current link.

Proposed fixes and/or additions

Correct current link to the proper release notes location i.e. https://docs.suitecrm.com/admin/releases/

Page with Issue

After te robo configuration an error message appear:
➜ Configure Test Environment Complete ERROR: Directive 'track_errors' is deprecated in Unknown:0

What is wrong, less clear, or missing

Proposed fixes and/or additions

See #4646

Hi Pedro

Do you intend to complete the content translation of this module?

It would be nice if the information in the documentation screenshots would be in one and only one language.

Well?

Use https://suitecrm.com/about/about-us/contact instead of https://salesagility.com/contact-us

Community Guide will include several parts of the old Documentation:

• Code of conduct
• Contributor Agreement
• Coding Standards
• Contributing to SuiteCRM
• Community Support

And some new things specific about the Documentation community efforts:

• how to contribute to Documentation site (both on GitHub and with local deployment)
• how to translate it
• style guide

This will also be a nice place to add instructions found on the Crowdin site about translating SuiteCRM itself.

Thank you for this wonderful project, i found an issue with the JSON API. Am using suitecrm Version 7.10.2

Page with Issue

https://docs.suitecrm.com/developer/api/version-8/json-api/

What is wrong, less clear, or missing

/api/v8/modules/Accounts?filter[Accounts.contacts.date_modified]=[[gt]]2017-11-17T11:40:00+00:00
There is a typo in the documentation it should be contacts with lowercase that Contacts
Also, Relationship filtering does not work. i tried the example and got the following:

{
    "errors": [
        {
            "code": 6000,
            "title": "[SuiteCRM] [InvalidArgumentException] [JsonApi][v1][Filters][Operators][Operator][hasOperator][expected type to be string] $operator",
            "status": 400
        }
    ],
    "meta": {
        "suiteapi": {
            "major": 8,
            "minor": 0,
            "patch": 0,
            "stability": "ALPHA"
        }
    },
    "jsonapi": {
        "version": "1.0"
    }
}

Proposed fixes and/or additions

Review the JSON API implementation

Page with Issue

https://suitecrm-docs.netlify.com/user/introduction/getting-started/

What is wrong, less clear, or missing

search box on the right does nothing

Proposed fixes and/or additions

tested with chrome browser and firefox browser
proposed solution: enable search on return command or insert a search button

On the Wiki Documentation site we have this Appendix on the user Guide:

https://suitecrm.com/wiki/index.php/Userguide#Appendix_A

We should use those field lists not as images, but as actual Asciidoc tables. But that takes a lot of work to produce, and risks going outdated quickly, as the code evolves. So it would be nice to extract that information with an automatic process, and dump it as a CSV.

Asciidoc can build tables dynamically from CSV, which is pretty cool.

I don't know exactly where that information can be extracted from, though.

Page with Issue

https://docs.suitecrm.com/developer/metadata/

What is wrong, less clear, or missing

In "Customising" area where you said:

...The modules metadata folder is the only location checked - any version in custom/<TheModule>/metadata/studio.php is ignored.

Proposed fixes and/or additions

I think you must say:

...The modules metadata folder is the only location checked - any version in custom/modules/<TheModule>/metadata/studio.php is ignored.

Make an evaluation of what kinds of stuff we have in the current User and Developer Guides:

• Admonitions (note, tip, warning, etc)
• Tables
• Captions
• etc

Then study the Asciidoc tutorials (that's our markup language!) and figure out what we can use to get better looking content.

Page with Issue

Translation of the developer guide into spanish

What is wrong, less clear, or missing

Proposed fixes and/or additions

Purpose

We want to improve our process by adding sanity checks to whatever people are proposing to be pulled into the Docs site, especially the published master branch.

Travis? Netlify?

We could call the test tools from Netlify before deploying. However, it can also be done in Travis and it has the advantage of making it run in paralell with the Netlify build (so we get the previews immediately). So we're planning to start adding tests to Travis which we already know well.

Suggested initial tool

Initially, I suggest starting with only this simple (and fast) tool:

https://github.com/wjdp/htmltest

It's ready for CI/CD development and is normally used with Travis, so it should be simple to set up (with @daniel-samson 's help?)

Ideas for later

We could do other sorts of tests:

1. More site sanity checks, not just broken links
2. Tests that check Asciidoc source, instead of rendered HTML content
3. Linters that do a higher level analysis to check for writing style

Page with Issue

https://docs.suitecrm.com/user/advanced-modules/cases-with-portal/

What is wrong, less clear, or missing

This sentence instructs the reader to install the "Joomla AOP component", however give no instructions on how to do that beyond telling them the use the "Joomla Extension Manger". Maybe, it's so simple it's not worth explaining how, but I cannot even find the "Joomla Extension Manager" in my SuiteCRM.

To install the Joomla AOP component, use the Joomla Extension Manager

Proposed fixes and/or additions

More information, or a link to full instructions would be really helpful. =)

This requires a lot of study and experimentation before starting to write...

• different types of Email accounts
• where to go to set them up
• how to test them
• different Email option that can be set
• how to use in-built Email client
• etc

Let's start with something short and simple, and build from there...

Page with Issue

https://docs.suitecrm.com/developer/api/version-8/json-api/#_module_record

What is wrong, less clear, or missing

Method for update is incorrect.

Proposed fixes and/or additions

Change PUT to PATCH

We have links on our site called “Edit this page”:

{{with $File.Path }}
      <div id="top-github-link">
        <a class="github-link" href="{{ $Site.Params.editURL }}{{ replace $File.Dir "\\" "/" }}{{ $File.LogicalName }}" target="blank">
          <i class="fa fa-code-fork"></i>
          {{T "Edit-this-page"}}
        </a>
       </div>
{{ end }}

This takes users to GitHub where they can edit the page’s source code, as intended.

The new challenge is: how to do something similar, but to Open an Issue on GitHub referencing the current page?

A nice addition would be the possibility to add some default labels.

Here is some Github syntax that should make this possible:

https://github.com/salesagility/SuiteDocs/issues/new?title=MyTitle&body=Some%20Text&labels=page-specific

Multiple labels: &labels=foo,bar
Other allowed variables: &assignee= and &milestone=

This does not use any authentication, which is what we want - just drop people on the page, and they take it from there. If they have a logged in Github user, it works, if not, they are asked to log in or create it.

Now we just need to make this work with our Hugo theme and with our specific Page Titles.

See Calculate Fields guide.
For example, the expression \{equal(parameter1;parameter2)} is displayed with backslash, without substitution.
Maybe use inline pass macro or triple pluse instead?

pass:[{equal(parameter1;parameter2)}]

+++{equal(parameter1;parameter2)}+++

all the initial design and CSS work!

Page with Issue

https://docs.suitecrm.com/admin/installation-guide/3.upgrading

What is wrong, less clear, or missing

Link to compatibility matrix is broken

Proposed fixes and/or additions

I created a pull request here #29 providing a way to solve the issue

Page with Issue

https://docs.suitecrm.com/developer/api/api-4_1/

What is wrong, less clear, or missing

The link in this warning message is broken:
This documentation pertains to SuiteCRM versions up to v.7.9.x. Since SuiteCRM version 7.10, a brand new v8 REST API is available.

Proposed fixes and/or additions

Remove: https://docs.suitecrm.com/developer/api/api-8
Add: https://docs.suitecrm.com/developer/api/version-8/

Do you have a plan to publish a full administrator's guide?
If so, it would be nice to know the chapters structure.

At the moment, the Russian Administrator guide consists of the following chapters (as on the administration page):

Пользователи / Users
Система / System
Администрирование электронной почты / Email
Инструментарий разработчика / Developer Tools
Настройка портала / AOP Settings
Настройка модулей продаж / AOS Settings
Настройка полнотекстового поиска / AOD Settings
Настройка графика работы / Business hours
Карты Google / Google Maps
Управление версиями / Releases
Управление перечнем сотрудников / Employee Records
Настройка дополнительных параметров / Advanced Configuration Options

(As you can see the Advanced OpenAdmin section has been divided into several separate chapters for greater convenience.)
Maybe we can use this structure (or part of it) in the future translation?

Page with Issue

Typos in PHP-Sourcecode:

First PHP example code:
https://raw.githubusercontent.com/salesagility/SuiteDocs/master/content/developer/API/version-8/Configure%20Authentication.adoc
Line 89:
'Accept: application/vnd.api+json',` (there is a ``` at the end of the line).

Line 98:
curl_setopt($ch, CURLOPT_URL, url);
$url instead of url

Second PHP example code:
L194 and L205 (same errors).

Maybe add echo $output; at the and of the examples.