Skip to content

Update abs.adoc #609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed

Conversation

animeshsrivastava24
Copy link
Contributor

Issue #604
@per1234 Please have a look. We can add further details to a mathematical section for more description.

Issue arduino#604 
@per1234  Please have a look. We can add further details to a mathematical section for more description.
Copy link
Collaborator

@per1234 per1234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your pull request @animeshsrivastava24! I think it's a bad idea to use an image from an external site. Every time that website moved the image, or if they shut down, it would break our documentation. What we need is an image that is licensed in a way that would allow us to add the file directly to this repository, following the example shown here:
https://github.com/arduino/reference-en/blob/master/AsciiDoc_sample/AsciiDoc_Dictionary/AsciiDoc_Template-Dictionary.adoc
From what I could see at the mathsisfun.com website you linked the image from, that image has an "All Rights Reserved" copyright and thus can not be used for our purposes. However, I'm certain there are public domain/Creative Commons images available, or at worst one could be created easily enough.

@animeshsrivastava24
Copy link
Contributor Author

@per1234 thank you so much for the suggestions, yes definitely we can create the images. I will create the samples and will update it to you soon.

@animeshsrivastava24
Copy link
Contributor Author

animeshsrivastava24 commented Jun 11, 2019

@per1234 To reference the issue, If we work to create images from our own, what guidelines should be followed. What properties and attributes must be present in the image? Please guide.

@per1234
Copy link
Collaborator

per1234 commented Jun 11, 2019

@animeshsrivastava24 I'm not sure. I'm intrigued by the idea of using graphs to make documentation more understandable. For me, the text is enough, but I know that some people are visual learners.

Maybe @robsoncouto and @SeppPenner have some opinions on this proposal they can share.

@SeppPenner
Copy link
Contributor

I agree with @per1234 that we need the image locally if we want to use an image. In general, I'm not a fan of putting a lot of pictures to the documentation but in this case it might make sense.

@animeshsrivastava24 I don't believe that there are some hard guidelines for images. I would reproduce the image https://www.mathsisfun.com/sets/images/function-absolute.svg but add some scale on the axes, too. I would leave out the yellow square, too. And add some description for the image. I mean, for me it's clear what abs() does, but for beginners the image might help.

@animeshsrivastava24
Copy link
Contributor Author

animeshsrivastava24 commented Jun 13, 2019

@per1234 @SeppPenner Thanks a lot for the valuable suggestions, sure, I'll work to create it locally. Also, if we want we can create a separate page for graphs and provide links to it in the documentation. I guess it will be easy to preserve the same standard format of Documentation everywhere and it will also guide the beginners with information they need.

@robsoncouto
Copy link
Contributor

Sorry for not replying to this before.

Adding graphs to the documentation would be a huge change, but I don't know if it would would be worth it. In my understanding, only a few people would benefit from it, while for the rest it may be redundant.

I think that uniformity may be a problem, so if images are to be used, there should be guidelines on how to create them, like the size, colors, etc. Also, If the images contain text, they may not be easily reused in the other translated references without editing.

Moreover, we can not just add pictures to the pages without context, but describing the picture (maths or electronics, for example) may not be the point of this documentation.

@animeshsrivastava24
Copy link
Contributor Author

Yes, I am too thinking about the method to include the graph with proper guidelines, and keeping in view the translation process, we can think of not including text on images for easy access and reproducibility across various language platforms.

I think that uniformity may be a problem, so if images are to be used, there should be guidelines on how to create them, like the size, colors, etc. Also, If the images contain text, they may not be easily reused in the other translated references without editing.

Moreover, we can not just add pictures to the pages without context, but describing the picture (maths or electronics, for example) may not be the point of this documentation.

So, before creating graphs, should I propose guidelines and method to include the graphs (Keeping in view the ideas of @SeppPenner ). Definitely, we all agree that the graphs should not be included in the present documentation to ensure uniformity across all the pages. So should we have a link to an image section (created as per requirement)?
@per1234 Please guide.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@per1234
Copy link
Collaborator

per1234 commented Aug 13, 2022

Thanks so much for your pull request @animeshsrivastava24. Since the PR's current approach of using a "hotlinked" image from an external source is not appropriate, I will close this.

@per1234 per1234 closed this Aug 13, 2022
@per1234 per1234 mentioned this pull request Aug 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants