Skip to content
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

Create TOYOTA's best practice documents #68

Open
wants to merge 72 commits into
base: master
Choose a base branch
from

Conversation

E-SAITO-TMC
Copy link

HMI's rules are defined in SDL official documentation, but behevior of HMI (HU) specifications when follow this rules are not defined.So, we would like add TOYOTA's HMI specifications as a reference information and share for when create HMI specifications.

@E-SAITO-TMC
Copy link
Author

@theresalech - san
Could you please review these documents?
Thank you.

@theresalech
Copy link
Contributor

Hi @E-SAITO-TMC thank you for submitting! We are currently completing development for the Core 6.1 release, so will take a look at this PR as soon as time allows and provide you with our estimated scope to review, provide feedback, and ultimately merge into the project. We can share this status with the Steering Committee at that time as well. Thanks again!

@E-SAITO-TMC
Copy link
Author

@theresalech -san
Thank you for your reply. I understand your current situation.
Sorry, I forgot to tell you that there is still two files that we will add next week.
So, I would like to ask for the review on those additional files.
Thank you again!

@E-SAITO-TMC
Copy link
Author

@theresalech -san
I added two files. So this PR is ready for review. Thank you!

@Jack-Byrne
Copy link
Collaborator

@E-SAITO-TMC Thank you for the PR. Please refer to this file : config.json and add your documentation chapters under an object named "Toyota's Best Practice Documents" or something similar. If done correctly, you should be able to preview your documentation from the "details" link shown by the repositories continuous integration.

Refer to picture:

Screen Shot 2020-03-23 at 4 40 09 PM

@E-SAITO-TMC E-SAITO-TMC force-pushed the feature/best_practice branch from f8890c6 to 611d4b1 Compare March 24, 2020 07:10
@E-SAITO-TMC
Copy link
Author

@JackLivio -san Thank you for your comment. I updated 'Config.json'. On the preview page, I found that layout is skewed and image is not display . So, I will update files.

@E-SAITO-TMC
Copy link
Author

I have completed all file changes.
Thank you.

@E-SAITO-TMC
Copy link
Author

@theresalech -san
The release of Core 6.1 is completed. could you review the documents?

@theresalech
Copy link
Contributor

Hi @E-SAITO-TMC, we will be reviewing these documents as soon as we can. Please note that Core 6.1 is not yet released; it is planned for release on April 29, so we may need to wait until then to review documentation, based on final testing and preparation for Core 6.1's release. Thank you for your patience!

For additional insight regarding our review of these documents, the team will be answering the following questions:

  • Can this information be added to an existing area of documentation? If so, we will let you know where we would like to add this information.
  • Is this information already included in our documentation? If so, we will let you know where this already exists.
  • Can this information apply to all SDL Core implementations, or is it Toyota-specific? If it's Toyota-specific, we will recommend this be added to Toyota's member page on the Developer Portal.

We will provide more information once we begin our review. Please let us know if you have any questions in the meantime. Thanks!

@E-SAITO-TMC E-SAITO-TMC force-pushed the feature/best_practice branch from 9aad3b7 to e26a136 Compare June 1, 2020 02:36
@E-SAITO-TMC E-SAITO-TMC force-pushed the feature/best_practice branch from eac4981 to 385b90f Compare June 1, 2020 04:06
@E-SAITO-TMC E-SAITO-TMC force-pushed the feature/best_practice branch from f15c3cc to 789f07d Compare June 1, 2020 09:02
@theresalech
Copy link
Contributor

Hi @E-SAITO-TMC-san, yes that is the correct location for Toyota-specific information. We do already include a link to this page from the SDLC Members Page (https://smartdevicelink.com/members/), by clicking on the Toyota logo. Thank you again for all of your recent commits and comments. Can you please advise once all PM comments have been addressed? We will then review and respond to all. Thank you!

@E-SAITO-TMC
Copy link
Author

@theresalech -san, Toyota aims to support the SDL development of other OEMs by publishing these documents. Another purpose is to reduce the differences in specifications between OEMs. The app developer has to follow the specifications of each OEM. By reducing the specification difference of each OEM, their development burden can be reduced.
If link to Toyota's member page from only the SDLC Members Page (https://smartdevicelink.com/members/), the SDL developers looking for HMI information may not find it. It's meaningless to publish it that way. Therefore, If we publish it on Toyota's member page, could you please link from the overview page? Thank you.

@theresalech
Copy link
Contributor

Hi @E-SAITO-TMC -san, The overview page is a table of contents for the Core Guides, so we don't think a link to Toyota's member page from here is appropriate. Instead, we'd propose including a link within the Core Guides FAQs: https://smartdevicelink.com/en/guides/core/faq/. Please let us know if this works for you. Thank you!

@E-SAITO-TMC
Copy link
Author

@theresalech -san, Thank you for your suggestions. However, when other OEMs introduce SDL, they refer to SDL Core Guides. I think they almost never refer to the Toyota's member page from the FAQ. What do you think? Do you have ideas other than the links from the overview page to achieve our goal?
Incidentally, If linking, we will name the link title "TOYOTA Specifications" instead of "Best Practices".

Also, We accept publishing the document on the Toyota's member page, so could you please tell me how to update it?

@theresalech
Copy link
Contributor

Hi @E-SAITO-TMC-san, I've sent you an email with additional information. Thank you!

@E-SAITO-TMC
Copy link
Author

@theresalech -san, Thank you for your email.
Let me confirm about updating the member page. I can see that only predetermined topics are able to be added some contents in that page. Uploading them on the developer page of TOYOTA and post the link with it is the only way to publish our documents in the member page? Is there any other way to do so?

@theresalech
Copy link
Contributor

Hi @E-SAITO-TMC-san, I've responded via email with more information about the SDLC member pages on the Developer Portal. If you have any further questions, please let me know via email, as we should keep this PR specific to information pertaining to the SDL Core Guides. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants