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

[Feat]: documentation does not remind users that they have to start the server by actually running "appium". #19973

Closed
zaphodikus opened this issue Apr 5, 2024 · 3 comments · Fixed by #20131
Labels
Documentation related to writing, reading, or generating documentation

Comments

@zaphodikus
Copy link

Is your feature request related to a problem? Please describe.
documentation does not remind users that they have to start the server by actually running "appium".

Describe the solution you'd like
Update the get started to actually explain what happens after they start the server and draw their attention to the console window so they remember that step, it's probably the biggest blocker to getting a test running and generates far too many forum questions. Maybe even make them understand what the log levels are and they will then always remember to check that the window has not hung or shows any errors.

Describe alternatives you've considered
I use a tool to do this for me, but most of the questions on forums are people who dont know and don't use a tool

Additional context
None

@eglitise
Copy link
Collaborator

eglitise commented Apr 5, 2024

It does already say this in the Installation part. Or is there another page you were thinking of?

@mykola-mokhnach mykola-mokhnach added Needs Info typically non-actionable; needs author to respond Documentation related to writing, reading, or generating documentation labels Apr 6, 2024
@zaphodikus
Copy link
Author

It then continues to tell you to stop the server.
"That's it! If you see this, the Appium server is up and running. Go ahead and quit it (Ctrl-C) and move on to the next step"

Now I've seen so many forum threads where people make the assumption that the test engine clients will start the server for you since it's just one command. Being able to pass in a port number for example is critical to being able to make really useful remote machine connections later, which are the true power of the driver server. The quick start guide is all about simple local connections only, but we need to remind users to check and start the server whenever it hangs up or errors out, and not wait for the client driver to error with an invalid session message.

@eglitise
Copy link
Collaborator

eglitise commented Apr 8, 2024

Thanks, I see what you mean and I fully agree that this should be clarified.

@eglitise eglitise removed the Needs Info typically non-actionable; needs author to respond label Apr 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation related to writing, reading, or generating documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants