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

Docs - Installed the SDK - What next? #22

Open
cwiechmann opened this issue Jan 27, 2021 · 1 comment
Open

Docs - Installed the SDK - What next? #22

cwiechmann opened this issue Jan 27, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@cwiechmann
Copy link

cwiechmann commented Jan 27, 2021

I think I have installed to Agent-SDK successfully, but now I don't exactly know what do next?

Can we add a few basic steps & information to the docs? Things like:

  • An explanation what happened based on the command: go get github.com/Axway/agent-sdk/
    • Basically what happens on my side, it cloned the GitHub Repo into go\src\github.com\Axway\agent-sdk - Is this correct?
    • I also got this message: package github.com/Axway/agent-sdk: no Go files in C:\Users\cwiechmann\go\src\github.com\Axway\agent-sdk
    • A few more general words about the SDK and how to use it would be great
  • What is now the next step to get started?
    • I'm a Go newbie and need some help
    • I checked the Discovery-Docs section, but looks already very specific
    • Is there any command to kickoff my work based on the SDK?
    • Or should I copy something ... ?
  • Also a recommendation about the tools you are using is always helpful and gives guidance
    • How to Debug
    • Are you using for example VS Code

Some kind of very basic Get started steps.

I know it might look basic, but we should not expect that people are already experienced and we should try to make it as simple as possible to get started to see first results. Based on that people can dig deeper.

@vivekschauhan
Copy link
Collaborator

Regarding the next step you can use the sample stub projects for both discovery and traceability agent (links towards the end of README) that can be used as the starting point to build your own agent. Both stubs have a README with some instructions and work out of box by building locally

@cbordier cbordier added documentation Improvements or additions to documentation question Further information is requested labels May 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants