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

issues in /documentation/usage.asciidoc #214

Closed
phschimm opened this issue Aug 21, 2019 · 4 comments
Closed

issues in /documentation/usage.asciidoc #214

phschimm opened this issue Aug 21, 2019 · 4 comments
Labels
bug Something isn't working documentation related to documentation (AsciiDoc) enhancement New feature or request
Milestone

Comments

@phschimm
Copy link
Member

phschimm commented Aug 21, 2019

issues:

  • following the instructions in step 3 results in launch-scripts with the name of the new workspace, however these scripts open an Eclipse/VSCode instance pointing to the "main" workspace

broken/wrong links:

realted notes:

  • new users might be confused about what to do in step 2, since checkout in most other VCS' is synonimous with git clone (which they are instructed to install), Git however also offers the command git checkout ...
@hohwille
Copy link
Member

@phschimm thanks for your constructive feedback. 👍

FYI: You could be even more supportive if you directly fix the documentation online:
0. ensure you have a github user and are logged in

  1. go the the documentation with your browser. E.g. https://github.com/devonfw/devon-ide/blob/master/documentation/usage.asciidoc
  2. click the pencil icon
  3. do the changes/fixes
  4. if you want click on the preview tab to check that all looks correct now
  5. go to the bottom of the page and create a new branch with your change
  6. click on create pull request
  7. submit the pull request

Please try it next time. It is super easy. Then I can see the diff of your changes and if all suites fine, I can just click merge and we are done. Explaining in detail which link is broken and should be changed how is IMHO more work that immediately fixing it (for you and me).

@hohwille
Copy link
Member

The fist aspect of this issue is not related to the documentation.
However, I retestet this and cannot confirm your bug report in this regard.
Which version of devon-ide where you using?
Can you retest and file a new individual issue only for that problem in case you can still reproduce this error (even with the latest beta version)?

@hohwille hohwille added this to the release:3.0.0 milestone Aug 23, 2019
@hohwille hohwille added bug Something isn't working documentation related to documentation (AsciiDoc) enhancement New feature or request labels Aug 23, 2019
hohwille added a commit that referenced this issue Aug 23, 2019
#198: fixed power-shell look&feel issue
#213: fixed cygwin setup
#214: fixed usage documentation
#216: no symlinks for cygwin
#219 fixed undefined variables
#220: use mklink on windows
#5: reduced export
in Eclipse show also IDE folder name in titlebar
@phschimm
Copy link
Member Author

I agree, I'll follow these steps next time (still learning Git/GitHub).
I was using beta17, but I'll retest it again and open another issue if the problem persists for me.

@hohwille
Copy link
Member

Fixed with PR #221

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation related to documentation (AsciiDoc) enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants