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

#1769 Rename Menas to rest-api #1781

Merged

Conversation

AdrianOlosutean
Copy link
Contributor

Brace yourselves, the first part of renaming
Closes #1769

@AdrianOlosutean
Copy link
Contributor Author

I'm not sure how exactly to handle the separation + renaming in README. Any proposals?

dk1844
dk1844 previously approved these changes May 6, 2021
Copy link
Contributor

@dk1844 dk1844 left a comment

Choose a reason for hiding this comment

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

I see nothing suspicious -> LGTM (just read the code)

Comment on lines 1 to 7
____ _____ ____ _____ _ ____ ___
| _ \| ____/ ___|_ _| / \ | _ \_ _|
| |_) | _| \___ \ | |_____ / _ \ | |_) | |
| _ <| |___ ___) || |_____/ ___ \| __/| |
|_| \_\_____|____/ |_| /_/ \_\_| |___|

version ${application.version}
Copy link
Contributor

Choose a reason for hiding this comment

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

Very cool 😎

Copy link
Contributor

Choose a reason for hiding this comment

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

While I agree, I would do this

Suggested change
____ _____ ____ _____ _ ____ ___
| _ \| ____/ ___|_ _| / \ | _ \_ _|
| |_) | _| \___ \ | |_____ / _ \ | |_) | |
| _ <| |___ ___) || |_____/ ___ \| __/| |
|_| \_\_____|____/ |_| /_/ \_\_| |___|
version ${application.version}
____ _____ ____ _____ _ ____ ___
| _ \| ____/ ___|_ _| / \ | _ \_ _|
| |_) | _| \___ \ | |_____ / _ \ | |_) | |
| _ <| |___ ___) || |_____/ ___ \| __/| |
|_| \_\_____|____/ |_| /_/ \_\_| |___|
Enceladus version ${application.version}

rest-api/Dockerfile Outdated Show resolved Hide resolved
@dk1844
Copy link
Contributor

dk1844 commented May 7, 2021

I'm not sure how exactly to handle the separation + renaming in README. Any proposals?

What do you have in mind specifically?
I would do about the following:

  • in README,
    • in the ### Menas section, I'd update that it is only UI front-end and a general-purpose service API exists behind it.
    • in the ## How to run / #### Menas requirements section, I'd state that it's menas-web.war now and reword that some requirements are tied to the service REST API instead of to Menas directly.
    • (not aware of any other adjustments needed there, but anything is possible)

Then, consider what else must change in the GHP description, what actually public API endpoints to describe (if the time is right?) and publish (in a sense of making them public) them that way. But GHP changes are another story (i.e. PR) anyway.

@@ -15,7 +15,7 @@

package za.co.absa.enceladus

package object menas {
package object restapi {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I could not name this package object in tests to rest_api. Hopefully it's not too confusing, given that the module is rest-api and the package is rest_api

Copy link
Contributor

Choose a reason for hiding this comment

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

I consider this acceptable.

Copy link
Contributor

@dk1844 dk1844 left a comment

Choose a reason for hiding this comment

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

LGTM (just read the code)

README.md Show resolved Hide resolved
@AdrianOlosutean AdrianOlosutean added the PR:no testing needed Only for PR - PR doesn't need to be tested by a tester (person) label May 14, 2021
@sonarqubecloud
Copy link

SonarCloud Quality Gate failed.

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 86 Code Smells

No Coverage information No Coverage information
4.2% 4.2% Duplication

@AdrianOlosutean AdrianOlosutean merged commit 88fabeb into develop-ver-3.0 May 14, 2021
@AdrianOlosutean AdrianOlosutean deleted the feature/1769-rename-menas-to-rest-api branch May 14, 2021 10:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR:no testing needed Only for PR - PR doesn't need to be tested by a tester (person)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants