question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[docs] Ambiguous development instructions

See original GitHub issue

Documentation for installing the project for development asks the user to clone the project as follows

git clone https://github.com/openwisp/ansible-openwisp2.git openwisp.openwisp2

On the other hand, instructions for running tests in the development environment asks to clone the project as follows:

git clone https://github.com/<your_fork>/ansible-openwisp2.git

I think the former is done to reuse the instructions for creating playbook given for end users while the latter is done to make tests work on Travis since it clones the project with the name of the project.

ansible-openwisp2/molecule/resources/converge.yml also uses ansible-openwisp2 role instead of openwisp.openwisp2

https://github.com/openwisp/ansible-openwisp2/blob/8ef2809ed9014b3420dd326426e0a1eb142ec30b/molecule/resources/converge.yml#L20-L21

I followed the first instruction only to find out that the test suite is not running. I had to manually fix above file to run tests.

It will be in the best interest to remove this ambiguity and use the same role for everything.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:9 (8 by maintainers)

github_iconTop GitHub Comments

1reaction
pandafycommented, May 12, 2022

This “How to test” part & module tests one was written much later, hence the difference, I think we can do with

git clone https://github.com/<your_fork>/ansible-openwisp2.git openwisp.openwisp2

(Using fork but naming it openwisp.openwisp2)

We can now do this change.

You can go ahead with this @Aryamanz29

0reactions
Aryamanz29commented, May 12, 2022

This “How to test” part & module tests one was written much later, hence the difference, I think we can do with

git clone https://github.com/<your_fork>/ansible-openwisp2.git openwisp.openwisp2

(Using fork but naming it openwisp.openwisp2)

We can now do this change.

You can go ahead with this @Aryamanz29

Thanks for confirming 👍

Read more comments on GitHub >

github_iconTop Results From Across the Web

Dealing with ambiguous requirements - Dani Kahil
Ambiguous requirements can create massive issues for you and your team. Beware of vague words, unquantifiable amounts and phrases that are open ...
Read more >
Types Of Ambiguities In A Document - LinkedIn
Based on their research, we identified the following types of ambiguities inherent in any software or related documents. Source: Identifying and ...
Read more >
Detecting Ambiguities in Requirements Documents Using ...
Ambiguous requirements are a serious problem in software development, because often stakeholders are not even aware that there is an ambiguity.
Read more >
AMBIGUOUS function - Progress Documentation
Returns a TRUE value if the last FIND statement for a particular record found more than one record that met the specified index...
Read more >
Ambiguous catalog matching when analysis + model have ...
Create a new file with the same contents as step 1, but under analysis/foo.sql . Repeat step 3, but this time, the documentation...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found