che-docs
che-docs copied to clipboard
eclipse-che
procedures: add docs for branding of Visual Studio Code - Open Source
Signed-off-by: Roman Nikitenko [email protected]
What does this pull request change?
Add docs for branding of Visual Studio Code - Open Source
What issues does this pull request fix or reference?
https://github.com/eclipse/che/issues/21682 https://issues.redhat.com/browse/CRW-3199
Specify the version of the product this pull request applies to
main and cherry-pick to 7.52.x, 7.53.x, 7.54.x
Pull Request checklist
The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.
- Any procedure:
- [x] Successfully tested.
- Any page or link rename:
- [ ] The page contains a redirection for the previous URL.
- Propagate the URL change in:
- [ ] Dashboard default branding data
- [ ] Chectl constants.ts
- [x] Builds on Eclipse Che hosted by Red Hat.
- [ ] the
Validate language on files added or modifiedstep reports no vale warnings.
🎊 Navigate the preview: https://637f8192319a39153b2f2e56--eclipse-che-docs-pr.netlify.app 🎊
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
The Build jobs failed because of a problem related to https://www.open-vsx.org/
The Build jobs failed because of a problem related to https://www.open-vsx.org/
That is prob just a temporary error.
I noticed the following warnings related to my changes:
I believe I already took care of those issues in my PR to your branch.
@max-cx
I've reviewed your changes - they look great for me, thank you!
There are few comments related to upstream/downstream docs:
To be honest, I'm not sure that we should consider branding for the devspaces-code repo.
For example, building images for the devspaces-code is not easy process. I would say it's defined for building images in Brew
This repo is used to house identical copies of the code used to build the Red Hat OpenShift Dev Spaces (formerly CodeReady Workspaces) images in Brew/OSBS, but made public to enable pull requests and easier contribution.
I don't know who could confirm that branding and building images for the devspaces-code should be included into the downstream docs. Probably, example of branding for the che-code is enough.
I'm ready to merge your PR, but I don't know if git history is important for you, so:
- can I merge it as is - so save all commits or
- do you prefer to squash it in the single commit or
- you would like to order git history (like - removing
che-theiabranding - one commit,vs-codebranding - another commit and so on)
To be honest, I'm not sure that we should consider branding for the
devspaces-coderepo. For example, building images for thedevspaces-codeis not easy process. I would say it's defined for building images in BrewThis repo is used to house identical copies of the code used to build the Red Hat OpenShift Dev Spaces (formerly CodeReady Workspaces) images in Brew/OSBS, but made public to enable pull requests and easier contribution.
I don't know who could confirm that branding and building images for the
devspaces-codeshould be included into the downstream docs. Probably, example of branding for theche-codeis enough.
@nickboldt and @l0rd, we need the possibility to brand devspaces-code for RH customers, don't we?
I'm ready to merge your PR, but I don't know if git history is important for you, so:
- can I merge it as is - so save all commits or
- do you prefer to squash it in the single commit or
- you would like to order git history (like - removing
che-theiabranding - one commit,vs-codebranding - another commit and so on)
@RomanNikitenko, thanks for asking, just squash it when it's ready for merging.
brand devspaces-code for RH customers
See CRW-3098: "Red Hat OpenShift Dev Spaces with Microsoft Visual Studio Code - Open Source IDE"
As to "do we want downstream docs on how to rebrand che-code as some other product?" I'd say maybe... but if there's decent doc upstream that's probably sufficient as customers can look there if they want to reskin the che project, or look in devspaces-images for the implementation. https://github.com/redhat-developer/devspaces-images/tree/devspaces-3-rhel-8/devspaces-code
@Kasturi1820 WDYT?
To be honest, I'm not sure that we should consider branding for the
devspaces-coderepo. For example, building images for thedevspaces-codeis not easy process. I would say it's defined for building images in Brew
To clarify a little, we could simplify building images for the devspaces-code.
Right now the build process is defined for building images in Brew. It includs some steps like:
- prepare assets
- publish assets to the github release
- dowload assets
So, I would say it works fine, but it's complicated for the end user. Also we could avoid those steps(at least, publish and download) in case of building images on a local machine.
We could provide a script to simplify process of building images locally on a machine. Like - a user runs the script => gets the target image.
Another way is - just provide a key for the existed get-sources.sh script. The key should allow just prepare assets (without publishing and then downloading them). It will allow to the end user build images in two steps:
- run
get-sources.shscript with the defined key (prepare assets) - run docker build
I don't see any other problems related to the docs of the devspaces-code if we provide a clear and simple process of building images for the end user.
prepare assets publish assets to the github release dowload assets
This is going to have to change soon -- ideally before the end of the year. See https://issues.redhat.com/browse/CRW-3160
There were few conflicts.
I rebased my branch and resolved them.
So I had to push my commits with force to update the PR.
Waiting for Robert's feedback to my suggestion for a separate guide for the VS Code content.
Closing this PR because this content has been migrated into the README in https://github.com/che-incubator/che-code/pull/155.