fiware-orion icon indicating copy to clipboard operation
fiware-orion copied to clipboard

[WIP] (JP) Rework Orion Japanese Documentation

Open fisuda opened this issue 2 years ago • 1 comments

The purpose of this PR is to implement the changes needed to improve Orion's Japanese documentation.

Related PR: #4141

  • [X] The commit c5cf1cf719a51f1183cb6ff36430fda018b0ad92 is in synchronization with the commit 8b1f70e5ca7fafb823e9dcebf3f09a989e23b993 in PR #4141. It contains updates merged by PR #4142, #4150, #4155, #4156. Compare: https://github.com/telefonicaid/fiware-orion/compare/637aed880b9971233f7934fdcc2d37f72063e1a0...8b1f70e5ca7fafb823e9dcebf3f09a989e23b993
  • [X] The commit e0f42485284c9592f8ed71d3d7e32e4d3c30d3d3 is in synchronization with PR #4158. Compare: https://github.com/telefonicaid/fiware-orion/compare/8b1f70e5ca7fafb823e9dcebf3f09a989e23b993...bff91ce7eb6df7712a5e1fc1a4e99b19f101e682
  • [X] The PR #4160 was not merged because Japanese documentation don't have a mkdocs.yml file for it.
  • [X] The commit 44bcb986ce4c6e5ed50c42c515e91c0cd732949f contains updates merged by PR #4165.
  • [X] The commit 58fa6872f818fe606a2bdcb08c936c8f6738654c contains updates merged by PR #4167. Compare: https://github.com/telefonicaid/fiware-orion/compare/601eb54da15f8b05a17f4715ee37290775a99f49...f09da37d3d3924fbbf724950ecec1d2a3b77bc22
  • [X] The commit 8dbabdbaa767b98075dbd02890b31e4ccf3df0a1 contains updates merged by PR #4173. Compare: https://github.com/telefonicaid/fiware-orion/compare/f09da37d3d3924fbbf724950ecec1d2a3b77bc22...c067029e0dab00f8d5e1a626565e7facd7b42c35
  • [X] The commit 18e0fda5ad26a01c8a7d217c48d62ee8f49dde71 contains updates merged by PR #4174. Compare: https://github.com/telefonicaid/fiware-orion/compare/c067029e0dab00f8d5e1a626565e7facd7b42c35...54f9b83ea0a14e72e4e137ed3f2f224fa33cf83d

Up to this point, no new content has been added with regards to the original NGSIv2 spec document. The next PRs will start adding/removing content, consolidating documentation in other .md files

  • [x] Add to orion-api.md the topics included in implementation notes documentation (several sub-PRs, to be defined)
    • [x] PR1 - Modify tables - The commit 12f7bfa27c47ab0c1764ef1562f584f1062a421c contains updates merged by PR #4176. Compare: https://github.com/telefonicaid/fiware-orion/compare/54f9b83ea0a14e72e4e137ed3f2f224fa33cf83d...f0f3196f1c583865d088e9e48bcfbf4609e1c83d
    • [x] PR2 - Encrich sections (direct mapping) - The commit 9d46d691589f357131fbfbcc3d76418b2e095e61 contains updates merged by PR #4181. Compare: https://github.com/telefonicaid/fiware-orion/compare/f0f3196f1c583865d088e9e48bcfbf4609e1c83d...c530a13cc695105bec2da3f90092453b83dab8ca
    • [X] PR3 - New sections - The commit updates merged by PR #4182. 2ce4e14ddd872f0b72556b21e0e9d2ddbb7ec9cc contaions Compare: https://github.com/telefonicaid/fiware-orion/compare/c530a13cc695105bec2da3f90092453b83dab8ca...f3633aae342b632902b3f1e0833ae20133c68431
    • [x] PR4 - "Differences regarding the original NGSIv2 spec" Section - This 1f54b9b81471b40559d68a1e35c239c7dba1e96f commit contains updates merged by PR #4183. Compare: https://github.com/telefonicaid/fiware-orion/compare/f3633aae342b632902b3f1e0833ae20133c68431...693481561783475e9e6ae27a6dff17812c7e23e2
    • [x] PR5 - Other changes - This d1f57de3cf35893c4499802497bf43cbb2c5eba9 commit contains updates merged by PR #4185. Compare: https://github.com/telefonicaid/fiware-orion/compare/693481561783475e9e6ae27a6dff17812c7e23e2...2d74cda487f70957f57c1a0ad64d29e5d3d2f50f
  • [ ] Integrate content from multitenancy.md and service_path.md
  • [ ] Fix https://github.com/telefonicaid/fiware-orion/issues/4178
  • [ ] Review GET /v2/types and GET /v2/types/{type} sections (some flaws exists)
  • [ ] Review orion-api.md to reorder sections and final cleanup fixes
  • [ ] Finally, review that Japanese documentation are in sync with English documentation

fisuda avatar Jul 07 '22 07:07 fisuda

Great! It seems at this moment this PR is in sync with PR https://github.com/telefonicaid/fiware-orion/pull/4141 :)

Please, keep and eye in PR #4141 as new sub-PRs are going to be merged there (indeed, a couple of new ones today)

CC: @mapedraza

fgalan avatar Jul 07 '22 12:07 fgalan

PR https://github.com/telefonicaid/fiware-orion/pull/4141 has been just merged.

@fisuda when this PR gets in sync with that one, please tell me about so I can also merge it. Thanks!

fgalan avatar Aug 30 '22 09:08 fgalan

PR #4141 has been just merged.

@fisuda when this PR gets in sync with that one, please tell me about so I can also merge it. Thanks!

Apart from that, some other side PRs has been merged into master (not sure if they also apply to the Japanese translation...)

  • PR https://github.com/telefonicaid/fiware-orion/pull/4197 - fix links for github.io web pages
  • PR https://github.com/telefonicaid/fiware-orion/pull/4205 - fix mkdocks.yml syntax error
  • PR https://github.com/telefonicaid/fiware-orion/pull/4206 - link fixes
  • PR https://github.com/telefonicaid/fiware-orion/pull/4207 - actual link fixes :)

fgalan avatar Aug 30 '22 11:08 fgalan

@fgalan This PR got in sync with that one. It would be great if you could review this PR. Thanks.

fisuda avatar Aug 31 '22 10:08 fisuda