camaraproject / EdgeCloud

Repository to describe, develop, document and test the EdgeCloud API family
Apache License 2.0
13 stars 44 forks source link

Repository cleanup #235

Closed Kevsy closed 1 month ago

Kevsy commented 2 months ago

What type of PR is this?

Add one of the following kinds:

What this PR does / why we need it:

Agreed on call 30th April 2024 - repository is difficult to navigate and contains many legacy/inactive documents. It is also not closely following the CAMARA repository structure

Which issue(s) this PR fixes:

Fixes #234

Special notes for reviewers:

Changelog input

 release-note

Additional documentation

This section can be blank.

docs
github-actions[bot] commented 2 months ago

πŸ¦™ MegaLinter status: ❌ ERROR

Descriptor Linter Files Fixed Errors Elapsed time
βœ… ACTION actionlint 2 0 0.03s
βœ… JSON eslint-plugin-jsonc 1 0 0 1.5s
βœ… JSON jsonlint 1 0 0.2s
βœ… JSON prettier 1 1 0 0.93s
βœ… JSON v8r 1 0 2.34s
❌ OPENAPI spectral 2 2 4.55s
βœ… REPOSITORY git_diff yes no 0.55s
βœ… REPOSITORY secretlint yes no 4.57s
❌ YAML yamllint 2 1 0.59s

See detailed report in MegaLinter reports

_MegaLinter is graciously provided by OX Security_

Kevsy commented 2 months ago

Tip for reviewers: clone the Kevsy-patch-10 branch to your local machine so you can browse the directory structure visually (Finder/Explorer)

Kevsy commented 2 months ago

@Kevsy, as we now have a β€˜child’ repository, would it be appropriate to include the link to refer to the fact that the SED API is now in that new repository?

Thanks @javierlozallu good idea, and done: I have removed the SED YAML from the Edge Cloud repo and instead left a link to the SED repo.

I have also made the fixes from your review (and @nicolacdnll 's review - thanks both)