Skip to content

Commit b38819a

Browse files
committed
fix links
1 parent 842b047 commit b38819a

File tree

3 files changed

+8
-11
lines changed

3 files changed

+8
-11
lines changed

fern/products/sdks/overview/python/publishing-to-pypi.mdx

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ You'll need to update your `generators.yml` file to configure the package name,
3232

3333
In the `group` for your Python SDK, change the output location in from `local-file-system` (the default) to `pypi` to indicate that Fern should publish your package directly to the PyPi registry:
3434

35-
```yaml title="Python" {6-7}
35+
```yaml title="generators.yml" {6-7}
3636
groups:
3737
python-sdk:
3838
generators:
@@ -49,7 +49,7 @@ You'll need to update your `generators.yml` file to configure the package name,
4949
Your package name must be unique in the PyPI repository, otherwise publishing your SDK to PyPI will fail.
5050

5151

52-
```yaml title="Python" {8}
52+
```yaml title="generators.yml" {8}
5353
groups:
5454
python-sdk:
5555
generators:
@@ -67,7 +67,7 @@ groups:
6767
The `client-class-name` option controls the name of the generated client. This is the name customers use to import your SDK (`import { your-client-name } from 'your-package-name';`).
6868

6969

70-
```yaml title="Python" {9-10}
70+
```yaml title="generators.yml" {9-10}
7171
groups:
7272
python-sdk:
7373
generators:
@@ -124,7 +124,7 @@ groups:
124124

125125
Add the path to your GitHub repository to `generators.yml`:
126126

127-
```yaml title="Python" {11-12}
127+
```yaml title="generators.yml" {11-12}
128128
groups:
129129
python-sdk:
130130
generators:
@@ -162,14 +162,14 @@ groups:
162162
</Step>
163163
<Step title="Choose your publishing mode">
164164

165-
<Markdown src="/snippets/github-publishing-mode.mdx"/>
165+
<Markdown src="/products/sdks/snippets/github-publishing-mode.mdx"/>
166166

167167
```yaml title="generators.yml" {14}
168168
groups:
169169
python-sdk:
170170
generators:
171171
- name: fernapi/fern-python-sdk
172-
version: <Markdown src="/snippets/python-sdk-version.mdx"/>
172+
version: <Markdown src="/snippets/version-number-python.mdx"/>
173173
output:
174174
location: npm
175175
package-name: name-of-your-package
@@ -182,7 +182,6 @@ groups:
182182
branch: your-branch-name # Required for mode: push
183183
```
184184

185-
186185
</Step>
187186
</Steps>
188187

fern/products/sdks/overview/typescript/publishing-to-npm.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ groups:
186186
</Step>
187187
<Step title="Choose your publishing mode">
188188

189-
<Markdown src="/snippets/github-publishing-mode.mdx"/>
189+
<Markdown src="/products/sdks/snippets/github-publishing-mode.mdx"/>
190190

191191
```yaml title="generators.yml" {14}
192192
groups:

fern/products/sdks/snippets/release-sdk.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,4 @@ The rest of the release process depends on your chosen mode:
22

33
- **Release mode (default):** If you didn't specify a `mode` or set `mode: release`, no further action is required. Fern automatically tags the new release with your specified version number and initiates the npm publishing workflow in your SDK repository.
44

5-
- **Pull request or push mode:** If you set `mode: pull-request` or `mode: push`, Fern creates a pull request or pushes to a branch respectively. Review and merge the PR (`pull-request`) or branch (`push`), then [tag a new release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) to initiate the npm publishing workflow in your SDK repository.
6-
7-
Once the workflow completes, you can view your new release by logging into npm and navigating to **Packages**.
5+
- **Pull request or push mode:** If you set `mode: pull-request` or `mode: push`, Fern creates a pull request or pushes to a branch respectively. Review and merge the PR (`pull-request`) or branch (`push`), then [tag a new release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) to initiate the npm publishing workflow in your SDK repository.

0 commit comments

Comments
 (0)