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

[Quick Start Guide] The order of the guide needs to be changed #8324

Closed
shavantha opened this issue May 1, 2018 · 5 comments
Closed

[Quick Start Guide] The order of the guide needs to be changed #8324

shavantha opened this issue May 1, 2018 · 5 comments

Comments

@shavantha
Copy link

Description:
As per the guide[1] we are expecting to run a hello-service.bal but the document first shows the run command and then only shows the sample hello-service.bal. Ideally, the code example should come on top followed by the ballerina init and ballerina run hello_service.bal commands

Based on the current order it is confusing to the user as there is no hello-service.bal to run as given on the top of the document

[1]https://ballerina.io/learn/quick-tour/

@samgnaniah
Copy link
Contributor

I think it's intentional so that they see the code first via the editor.

@shavantha
Copy link
Author

cant we move the step ballerina run hello_service.bal after showing the code yesterday I was initially thinking that hello-world-service.bal in examples were to be used instead of hello-service.bal becuase i was not able to locate the code to run,

currently the user has to scroll down to locate the code and then come backup to read the remaining steps :)

@samgnaniah
Copy link
Contributor

Yes, that might work. Will have a look and see if it makes sense.

@samgnaniah
Copy link
Contributor

I'd like more opinions before we implement to be honest. I feel it's nice to see something working within the first few clicks itself. Gives a good impression. Shall we start a thread and discuss?

@anupama-pathirage
Copy link
Contributor

Created https://github.com/ballerina-platform/ballerina-www/issues/878 to track this. Hence closing this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants