miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity

docs(nx-cloud): fix formatting and wording (#28749)

Browse Source 
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
<!-- This is the behavior we have today -->

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #
This commit is contained in:
Rares Matei 2024-11-04 12:03:20 +00:00 committed by GitHub
parent 796862d9f4
commit ba762101ad
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/nx-cloud/enterprise/single-tenant/custom-github-app.md
View File

@ -2,7 +2,7 @@
Before creating your container, you'll need to create a GitHub app for your organisation. Before creating your container, you'll need to create a GitHub app for your organisation.
## Creating a GitHub OAuth app ## Creating a GitHub app
From GitHub, click on your profile picture and chose "Settings": From GitHub, click on your profile picture and chose "Settings":

12
docs/nx-cloud/reference/release-notes.md
View File

@ -4,12 +4,12 @@
This is a big release so let's go through the highlights first. There is also an important "Breaking changes" section at the end. This is a big release so let's go through the highlights first. There is also an important "Breaking changes" section at the end.
## New Version Structure ##### New Version Structure
We have changed our version structure to a more simplified tag: `YEAR.MM.PATCH_NUMBER` We have changed our version structure to a more simplified tag: `YEAR.MM.PATCH_NUMBER`
The goal is to make it easier to spot how old/recent your existing NxCloud version is and compare it against newer deployments. The goal is to make it easier to spot how old/recent your existing NxCloud version is and compare it against newer deployments.
## DTE Summary Table on Main Agent ##### DTE Summary Table on Main Agent
When distributing with DTE, up until now, we have been replaying all your tasks logs "as they come in" from the DTE agents back onto your main job. When distributing with DTE, up until now, we have been replaying all your tasks logs "as they come in" from the DTE agents back onto your main job.
@ -19,7 +19,7 @@ This release contains the new "CI Table Log View" summary, and you can read all
If you prefer the old logs style, you can always disable the feature via your workspace's settings screen. If you prefer the old logs style, you can always disable the feature via your workspace's settings screen.
## Personal Access Tokens ##### Personal Access Tokens
Up until now, for developers to get access to read (and maybe write) to the cache you always needed an access token to be made available locally: either Up until now, for developers to get access to read (and maybe write) to the cache you always needed an access token to be made available locally: either
committed to the repo via `nx.json` or made available as an env variable via a `.local.env` file. committed to the repo via `nx.json` or made available as an env variable via a `.local.env` file.
@ -34,7 +34,7 @@ The moment they get removed as a member from your workspace, they won't be able
Please read the full announcement post here, as it contains details on how to migrate your team to using [Personal Access Tokens](/blog/personal-access-tokens). Please read the full announcement post here, as it contains details on how to migrate your team to using [Personal Access Tokens](/blog/personal-access-tokens).
## GitHub App Integration ##### GitHub App Integration
If you are using GitHub, setting up a custom GitHub app for your org is the best way to take advantage of all the latest "GitHub-specific" features we offer. If you are using GitHub, setting up a custom GitHub app for your org is the best way to take advantage of all the latest "GitHub-specific" features we offer.
Please see instructions [here](/ci/recipes/enterprise/single-tenant/custom-github-app) on setting up an app. Please see instructions [here](/ci/recipes/enterprise/single-tenant/custom-github-app) on setting up an app.
@ -43,7 +43,7 @@ You will then need to make sure you set up your VCS integration again through yo
As part of this, you will also get the "GitHub membership management" feature, where everybody who is a collaborator of your GitHub repo will also get "read" access to your NxCloud workspace, As part of this, you will also get the "GitHub membership management" feature, where everybody who is a collaborator of your GitHub repo will also get "read" access to your NxCloud workspace,
without you having to explicitly invite them. without you having to explicitly invite them.
## Misc Items ##### Misc Items
- Improved docker agents support - Improved docker agents support
- We fixed a few issues related to running docker builds in Nx Agents - We fixed a few issues related to running docker builds in Nx Agents
@ -54,7 +54,7 @@ without you having to explicitly invite them.
- Various SAML fixes and improvements - Various SAML fixes and improvements
- One highlight is that users can now login from Okta directly (while before they had to initiate login through NxCloud web app) - One highlight is that users can now login from Okta directly (while before they had to initiate login through NxCloud web app)
## Breaking Changes ##### Breaking Changes
Most workspaces will not be affected by this, but if you have these values configured in your `helm-config.yaml`: Most workspaces will not be affected by this, but if you have these values configured in your `helm-config.yaml`: