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

Documentation about Git repositories URLs is not complete #22356

Closed
l0rd opened this issue Jul 11, 2023 · 0 comments
Closed

Documentation about Git repositories URLs is not complete #22356

l0rd opened this issue Jul 11, 2023 · 0 comments
Assignees
Labels
area/doc Issues related to documentation kind/bug Outline of a bug - must adhere to the bug report template. severity/P1 Has a major impact to usage or development of the system.
Milestone

Comments

@l0rd
Copy link
Contributor

l0rd commented Jul 11, 2023

Describe the bug

  • Article "Authenticating to a Git server from a workspace" is missing the SSH key option for GIT + SSH URLs. Note that the SSH keys configuration is documented in DevWorkspace doc.

  • Article "Starting a new workspace with a clone of a Git repository" doesn't mention that:

  • And the same article has also some other things to review:

    • GitHub and GitLab share the same samples? Really? Also for merge requests?
    • The workspace URL is wrong / not up to date
    • There is an unnecessary documentation how to add bookmarks in FF and Chrome
    • The initial paragraph, where all URLs are defined...Isn't that too complicated for an icebreaker?
  • Article "Starting a new workspace from a devfile URL" should warn what we lose when using a raw Devfile URL:

    • the devfile needs to have the repo and branch hardcoded (i.e. you can't use it in a different fork or branch)
    • the devfile needs to be in a public repository
    • OAuth flow that automate git credential injection is not support (users needs to manually create credentials/SSH secrets)

Che version

7.70@latest

@l0rd l0rd added the kind/bug Outline of a bug - must adhere to the bug report template. label Jul 11, 2023
@che-bot che-bot added the status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. label Jul 11, 2023
@l0rd l0rd changed the title Documentation about Git repositoreis URLs is not complete Documentation about Git repositories URLs is not complete Jul 11, 2023
@l0rd l0rd added severity/P1 Has a major impact to usage or development of the system. area/doc Issues related to documentation and removed status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. labels Jul 12, 2023
@ibuziuk ibuziuk moved this to 📅 Planned in Eclipse Che Team A Backlog Jul 12, 2023
@tolusha tolusha self-assigned this Aug 16, 2023
@tolusha tolusha moved this from 📅 Planned to 🚧 In Progress in Eclipse Che Team A Backlog Aug 16, 2023
@tolusha tolusha moved this from 🚧 In Progress to Ready for Review in Eclipse Che Team A Backlog Aug 24, 2023
@tolusha tolusha moved this from Ready for Review to 🚧 In Progress in Eclipse Che Team A Backlog Aug 24, 2023
@tolusha tolusha added this to the 7.74 milestone Aug 24, 2023
@tolusha tolusha closed this as completed Aug 24, 2023
@tolusha tolusha moved this from 🚧 In Progress to ✅ Done in Eclipse Che Team A Backlog Aug 24, 2023
@ibuziuk ibuziuk modified the milestones: 7.74, 7.73 Aug 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/doc Issues related to documentation kind/bug Outline of a bug - must adhere to the bug report template. severity/P1 Has a major impact to usage or development of the system.
Projects
None yet
Development

No branches or pull requests

4 participants