search

INTO-CPS-Association / Documentation

Contains documentation such as user manual, examples compendium etc.
Other
2 stars 5 forks source link

Improve Modelio documentation style and dead link #12

Open clegaard opened 4 years ago

clegaard commented 4 years ago

Currently, the style of Modelio's docs is very different than the rest of the documentation and appears out of date.

image

Concretely:

  1. hyperlinks are written out in full length and are not integrated in the text.
  2. latest Modelio version is stated as 3.0.1, which is incorrect "Latest version: 4.0.1 (Last update on February 3rd, 2020)"
  3. link to "community quick start guide" is dead image
  4. some information is outdated and can easily be found at their website, such as the latest version (can always be found on their website and is prone to change)

Asides from the dead link this is a matter of style, but it does send a bad impression for the docs to be outdated. @pglvdm do you know who is the owner of the documentation? If so I can reach out and hear if they are willing to update the contents.

etiennebrosse commented 4 years ago

Dear Christian,

I will update the content of Modelio documentation by the end of this week (Thursday or Friday). Is it fine with you?

Best, Etienne Brosse

De : Christian Møldrup Legaard notifications@github.com Envoyé : 07 September 2020 22:03 À : INTO-CPS-Association/Documentation Documentation@noreply.github.com Cc : Subscribed subscribed@noreply.github.com Objet : [INTO-CPS-Association/Documentation] Improve Modelio documentation style and dead link (#12)

Currently, the style of Modelio's docs is very different than the rest of the documentation and appears out of date.

[image]https://user-images.githubusercontent.com/18687499/92414316-fbf5f000-f153-11ea-8b14-8a93865eee40.png

Concretely:

  1. hyperlinks are written out in full length and are not integrated in the text.
  2. latest Modelio version is stated as 3.0.1, which is incorrect "Latest version: 4.0.1 (Last update on February 3rd, 2020)"
  3. link to "community quick start guide" is dead [image]https://user-images.githubusercontent.com/18687499/92414506-cac9ef80-f154-11ea-96b8-40ddfcf67555.png
  4. some information is outdated and can easily be found at their website, such as the latest version (can always be found on their website and is prone to change)

Asides from the dead link this is a matter of style, but it does send a bad impression for the docs to be outdated. @pglvdmhttps://github.com/pglvdm do you know who is the owner of the documentation? If so I can reach out and hear if they are willing to update the contents.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHubhttps://github.com/INTO-CPS-Association/Documentation/issues/12, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ABJ5F7JJUO5F754Y5DIXVZDSEU35PANCNFSM4Q62NM7A.

clegaard commented 4 years ago

That would be great. I have written a short contributers guide that contains resources that may be useful to you.

If you have questions or encounter any issues feel free to email me or write a message in our chat

etiennebrosse commented 4 years ago

Ok Thanks.

Etienne

De : Christian Møldrup Legaard notifications@github.com Envoyé : 07 September 2020 22:32 À : INTO-CPS-Association/Documentation Documentation@noreply.github.com Cc : BROSSE Etienne etienne.brosse@softeam.fr; Comment comment@noreply.github.com Objet : Re: [INTO-CPS-Association/Documentation] Improve Modelio documentation style and dead link (#12)

That would be great. I have written a short contributers guidehttps://into-cps-association.readthedocs.io/en/latest/contributers_guide.html#updating-the-documentation that contains resources that may be useful to you.

If you have questions or encounter any issues feel free to email me or write a message in our chathttps://gitter.im/INTO-CPS/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link

— You are receiving this because you commented. Reply to this email directly, view it on GitHubhttps://github.com/INTO-CPS-Association/Documentation/issues/12#issuecomment-688501378, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ABJ5F7PMZV7MP3QIY5EYQNTSEU7KHANCNFSM4Q62NM7A.