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

Cleanup repo #1394

Merged
merged 3 commits into from
Oct 17, 2024
Merged

Cleanup repo #1394

merged 3 commits into from
Oct 17, 2024

Conversation

ale8k
Copy link
Contributor

@ale8k ale8k commented Oct 17, 2024

We had some old docs that aren't too useful or were outdated, like asyncapi, facade and howto vault. Additionally I've renamed compose-common, so it's in the conventional naming format for multiple files. We had an old docker file that wasn't used, that's been cleaned up too and finally there was a set-version script that wasn't used. I removed this directory too.

Description

The what and why - include a summary of the change, describe what it does, and include relevant motivation and context.

Fixes JIRA/GitHub issue number

Engineering checklist

Check only items that apply

  • Documentation updated
  • Covered by unit tests
  • Covered by integration tests

Test instructions

Notes for code reviewers

We had some old docs that aren't too useful or were outdated, like asyncapi, facade and howto vault. Additionally I've renamed compose-common, so it's in the conventional naming format for multiple files. We had an old docker file that wasn't used, that's been cleaned up too and finally there was a set-version script that wasn't used. I removed this directory too.
@ale8k ale8k requested a review from a team as a code owner October 17, 2024 08:53
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we rather update this doc to document the JIMM facades? Maybe just one-liners like
JIMM offers these custom facades:

  • AddRelation
  • ...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly I don't see a point... Proper doccos in jaas-docs is better I think idk... we can revisit doccing jaas specific later maybe?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually lets see what guys think @alesstimec @SimoneDutto

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since we have the godoc in JIMM methods i dont' see the point of having this doc

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, can cut it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since we have the godoc in JIMM methods i dont' see the point of having this doc

@ale8k
Copy link
Contributor Author

ale8k commented Oct 17, 2024

OKi, will merge @SimoneDutto @kian99

@ale8k ale8k merged commit ebfa5b4 into canonical:v3 Oct 17, 2024
4 checks passed
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.

3 participants