User-configurable stack name in init-odkx-sync-endpoint.py

odk-x / tool-suite-X

ODK-X Tool Suite Project roadmaps, issue queue, release notes and wiki.

https://www.odk-x.org

Apache License 2.0

25 stars 43 forks source link

User-configurable stack name in init-odkx-sync-endpoint.py #194

Open linl33 opened 3 years ago

linl33 commented 3 years ago

init-odkx-sync-endpoint.py hard-coded the stack name syncldap. A user-configurable stack name would be useful.

Repository https://github.com/odk-x/sync-endpoint-default-setup

adityaofficial10 commented 3 years ago

Hey! @linl33 So we need to ask the user for the stack name right? Can I work on this issue?

linl33 commented 3 years ago

Hi @adityaofficial10!

Yes, you can work on this issue. The idea is that the script should prompt for a stack name but default to syncldap (the current name). The script should also store the chosen stack name to its settings file.

adityaofficial10 commented 3 years ago

@linl33 Sure, I'll follow this up with a PR shortly.

adityaofficial10 commented 3 years ago

@linl33 I have made the changes as shown below:

Is this fine? Also, you were talking about the settings file. Which file is that exactly?

linl33 commented 3 years ago

The function is correct but a few notes on the implementation,

Please move the prompt into run_interactive_config, to keep it consistent with the rest of the configuration
Please put the default value into [()], e.g. Please enter a name for the Docker Swarm stack [(syncldap)]
Please use String interpolation instead of concatenation

For the settings file, see https://github.com/odk-x/sync-endpoint-default-setup/blob/0d97f322b6f3c48f86cdb47c9c1c7acf3f7bfb93/init-odkx-sync-endpoint.py#L134

Let me know if you have questions. Thanks for the work so far!

adityaofficial10 commented 3 years ago

@linl33 I've made the required changes. I'm sending you a link to the file in my fork. Kindly review and inform if I can improve something. https://github.com/adityaofficial10/sync-endpoint-default-setup/blob/fix/stack-name-added/init-odkx-sync-endpoint.py Can I open a PR?

linl33 commented 3 years ago

Yes, please send a pull request against the development branch.

adityaofficial10 commented 3 years ago

@linl33 I've linked the PR.

wbrunette commented 2 years ago

For future reference for someone taking on this issue. Take a look at the previous incomplete PR. https://github.com/odk-x/sync-endpoint-default-setup/pull/26

The comments in the PR give additional direction

wsmmxmm commented 2 years ago

Hi team! I am an outreachy applicant. Please can I work on this issue if it is still open?

wbrunette commented 2 years ago

@wsmmxmm it is still open. I will assign it to you. Check out the PR I commented about as much of the work has been attempted once, just not fully completed.

Ndacyayisenga-droid commented 1 year ago

@wbrunette @linl33 @elmps2018 Can I finish up with this if its still open? Regards, Noah

MariaAngella commented 1 year ago

Hello team,

Can I take this on please, I'm an Outreachy applicant.

Thank you and regards, Maria Angella

elmps2018 commented 1 year ago

Hi @MariaAngella! @wsmmxmm is currently assigned but does not look like they worked on it lately. @wbrunette @wsmmxmm is it okay if I reassign?

wbrunette commented 1 year ago

You should first ask the question if they want to have a custom stack name. Because if they change it the directions will not match. So really it's two questions.

MariaAngella commented 1 year ago

Thank you for this assignment.