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.

Sign up for GitHub

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

Jump to bottom

refactor: move documentation from individual services to a new section under Automated Self Checkout in doc repo #51

Open
ejlee3 opened this issue Feb 28, 2025 · 2 comments · Fixed by francis-tanyx/automated-self-checkout#2 · May be fixed by intel-retail/automated-self-checkout#677 or #57
Open

refactor: move documentation from individual services to a new section under Automated Self Checkout in doc repo #51

ejlee3 opened this issue Feb 28, 2025 · 2 comments · Fixed by francis-tanyx/automated-self-checkout#2 · May be fixed by intel-retail/automated-self-checkout#677 or #57
Labels
Beginner documentation Improvements or additions to documentation

Comments

@ejlee3
Copy link
Contributor

ejlee3 commented Feb 28, 2025

Remove the following Readme's from automated self checkout repo and migrate this doc repo.

https://github.com/intel-retail/automated-self-checkout/blob/main/src/common-service/README.md
https://github.com/intel-retail/automated-self-checkout/blob/main/src/pipeline-server/readme.md
https://github.com/intel-retail/automated-self-checkout/blob/main/src/retail-data-visualization/README.md

  1. Create a section under Use Cases/Automated Self Checkout
  2. Rename the files based on the service
  3. update the mkdocs.yml with the new files under a section called Services
  4. Ensure that visualization works for docs.
@ejlee3 ejlee3 added documentation Improvements or additions to documentation Beginner labels Feb 28, 2025
@francis-tanyx
Copy link

IRAISuite_Team2 will be working on this issue.

@ysvoon ysvoon mentioned this issue Mar 5, 2025
Merged
4 tasks
ysvoon added a commit to francis-tanyx/documentation that referenced this issue Mar 5, 2025
@ysvoon
Refactor Issue 51: Migrated documentation from individual services to…
2a8643b 
… a Services section under Automated Self Checkout in Documentation Repo

- created section `Services` under Use Cases/Automated Self Checkout
- renamed the files based on the service (common-service, pipeline-server, retail-data-visualization)
- updated the mkdocs.yml with the new files under a section called Services
- ensured that visualization works for docs

Issue (intel-retail#51)[intel-retail#51] 
 
Co-authored-by: Voon Yong Shing <[email protected]>
Signed-off-by: Tan Yan Xue <[email protected]>
Signed-off-by: Ong Jing Hong <[email protected]>
Signed-off-by: Marcus Khaw Chin Rui <[email protected]>
Signed-off-by: Low Yu Zhe <[email protected]>
@ysvoon ysvoon mentioned this issue Mar 5, 2025
Merged
9 tasks
ysvoon added a commit to francis-tanyx/automated-self-checkout that referenced this issue Mar 5, 2025
@ysvoon
Refactor Issue 51: Removed readme files after migrate to Documentatio…
e8f0958 
…n repo

- removed the readme files from common-service, pipeline-server and retail-data-visualization after migrating to Documentation repo

Issue intel-retail#51 intel-retail/documentation#51
 
Co-authored-by: Voon Yong Shing <[email protected]>
Signed-off-by: Tan Yan Xue <[email protected]>
Signed-off-by: Ong Jing Hong <[email protected]>
Signed-off-by: Marcus Khaw Chin Rui <[email protected]>
Signed-off-by: Low Yu Zhe <[email protected]>
This was referenced Mar 5, 2025
Open
Closed
Open
Merged
francis-tanyx added a commit to francis-tanyx/documentation that referenced this issue Mar 5, 2025
@francis-tanyx
Refactor Issue 51: Migrated documentation from individual services to…
d5e032a 
… a Services section under Automated Self Checkout in Documentation Repo

- created section `Services` under Use Cases/Automated Self Checkout
- renamed the files based on the service (common-service, pipeline-server, retail-data-visualization)
- updated the mkdocs.yml with the new files under a section called Services
- ensured that visualization works for docs

Issue (intel-retail#51)[intel-retail#51] 
 
Co-authored-by: Voon Yong Shing <[email protected]>
Signed-off-by: Tan Yan Xue <[email protected]>
Signed-off-by: Ong Jing Hong <[email protected]>
Signed-off-by: Marcus Khaw Chin Rui <[email protected]>
Signed-off-by: Low Yu Zhe <[email protected]>
@francis-tanyx francis-tanyx mentioned this issue Mar 5, 2025
Merged
4 tasks
francis-tanyx added a commit to francis-tanyx/documentation that referenced this issue Mar 5, 2025
@francis-tanyx
Refactor Issue 51: Migrated documentation from individual services to…
e7be64a 
… a Services section under Automated Self Checkout in Documentation Repo

- created section `Services` under Use Cases/Automated Self Checkout
- renamed the files based on the service (common-service, pipeline-server, retail-data-visualization)
- updated the mkdocs.yml with the new files under a section called Services
- ensured that visualization works for docs

Issue (intel-retail#51)[intel-retail#51] 
 
Co-authored-by: Voon Yong Shing <[email protected]>
Signed-off-by: Tan Yan Xue <[email protected]>
Signed-off-by: Ong Jing Hong <[email protected]>
Signed-off-by: Marcus Khaw Chin Rui <[email protected]>
Signed-off-by: Low Yu Zhe <[email protected]>
@francis-tanyx francis-tanyx linked a pull request Mar 5, 2025 that will close this issue
Open
4 tasks
@francis-tanyx
Copy link

@ejlee3 @antoniomtz @NeethuES-intel

Attached is the latest changes for migrating the MD files of individual services into uses-cases/automated-self-checkout in Documentation repo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Beginner documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
2 participants
@ejlee3 @francis-tanyx