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

Check and correct links due to document management directory changes #82

Closed
yunkon-kim opened this issue Aug 2, 2023 · 4 comments
Closed

Comments

@yunkon-kim
Copy link
Member

Depending on the organization's decision, there will be changes to the directory structure.

This will cause issues with referencing links within the organization.

Therefore, we try to check and correct the links in each repository and wiki.

Work will be carried out sequentially.

(As-Is)

technical_docs
    ├── API
    ├── design
    ├── features
    └── requirements

(To-Be)

technical_docs
    ├── cloud-barista  
    │    ├── API
    │    ├── design
    │    ├── features
    │    └── requirements
    └── cloud-migrator
         ├── API
         ├── design
         ├── features
         └── requirements
@yunkon-kim
Copy link
Member Author

@powerkimhub

Early 배포가 예정되어 있어, cb-spider repo 및 wiki를 우선 확인하였습니다.

(Repo) technical_docs 관련 경로는 검색되지 않았습니다.

(Wiki) 아래 한 부분이 검색 되었습니다.

Wiki 이므로 바로 반영하겠습니다.
_Sidebar.md

-    * [How to add a new API to the gRPC Go API](https://github.com/cloud-barista/docs/blob/master/technical_docs/API/CB-User_gRPC-Go-API-update_guide.md)
+    * [How to add a new API to the gRPC Go API](https://github.com/cloud-barista/docs/blob/master/technical_docs/cloud-barista/API/CB-User_gRPC-Go-API-update_guide.md)

@powerkimhub
Copy link
Member

@yunkon-kim

  • 넵, 감사합니다.

@yunkon-kim
Copy link
Member Author

yunkon-kim commented Aug 2, 2023

@seokho-son

cb-tumblebug repo에서 technical_docs 관련 경로는 검색되지 않았습니다.

technical_docs는 CB-Tumblebug-User_interface.md 파일에서 2곳 수하였습니다.

(별도로) wiki clone시 invalid path 이슈가 발생하여, 아래 wiki의 파일명을 수정하였습니다. 아래 문서들을 참조하는 repo내 파일 또는 wiki는 없는것까지 확인하였습니다.

  • 'Call-chains-of-functions-in-src-core-mcis-*.go.md' -> Call chains of functions in src core mcis
  • 'Info:-Go-struct---JSON-field-name-match-table.md' -> [Info] Go struct JSON field name match table
  • 'Info:-How-to-update-Swagger-annotations-in-CB-Tumblebug.md' -> [Info] How to update Swagger annotations in CB
  • 'func-check*-{Ns,-Mcis,-Vm,-Resource}.md' -> func check, all of Ns, Mcis, Vm, Resource

@seokho-son
Copy link
Member

I guess this issue has been resolved. :)
let me close, feel free to reopen if neccessary.

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

No branches or pull requests

3 participants