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

Broken Links to postman collections #1574

Closed
lewisdaly opened this issue Aug 11, 2020 · 5 comments
Closed

Broken Links to postman collections #1574

lewisdaly opened this issue Aug 11, 2020 · 5 comments
Assignees
Labels
oss-core This is an issue - story or epic related to a feature on a Mojaloop core service or related to it
Milestone

Comments

@lewisdaly
Copy link
Contributor

Summary:
In both the mojaloop/postman README.md and in the Automated Testing section of the documentation, there are broken and outdated links to the postman collections.

In order to make onboarding easier, we need to:

  1. Clean up duplicate or unused/outdated postman collections
    • Perhaps we can make an ./archive directory for those collections we don't want to delete, but also don't want to confuse new users with
  2. Establish some better naming and versioning conventions for postman collections
  3. Fix up our documentation to refer to the postman collections correctly

Severity:
High

Priority:
Medium

Expected Behavior

  • When I click on links to postman collections, they should resolve correctly
  • When a new postman collection is created, it should follow good naming conventions

Steps to Reproduce
1.
2.
3.

Specifications

  • Component (if known):
  • Version:
  • Platform:
  • Subsystem:
  • Type of testing:
  • Bug found/raised by: @lewisdaly

Notes:

  • Severity when opened:
  • Priority when opened:
@lewisdaly lewisdaly added bug oss-core This is an issue - story or epic related to a feature on a Mojaloop core service or related to it labels Aug 11, 2020
@lewisdaly
Copy link
Contributor Author

Some recommendations for collection naming conventions:

  • We remove the word mojaloop from the collections as it's redundant.
  • Never use the word new or old in a collection name. We should rely on either git or exact release names which correlate to help releases
  • decide on using underscores _ or dashes - to separate out words/sections . We should never use spaces, since that makes scripting much harder. Alternatively we could use CasesToSeparateOutWords, but that gets harder to read in my opinion

@lewisdaly
Copy link
Contributor Author

First PR to clean up the readme references: mojaloop/postman#159

@lewisdaly
Copy link
Contributor Author

Fixed in the postman repo, but now we need to address it in the documentation repo.

We might be better off looking at the naming conventions first, so we have better consistency and don't break links again.

@elnyry-sam-k elnyry-sam-k self-assigned this Oct 6, 2020
@elnyry-sam-k elnyry-sam-k added this to the Sprint 11.6 milestone Oct 6, 2020
@lewisdaly
Copy link
Contributor Author

Yeah I'd say so. Do we need to release the documentation?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
oss-core This is an issue - story or epic related to a feature on a Mojaloop core service or related to it
Projects
None yet
Development

No branches or pull requests

2 participants