Skip to content

Commit

Permalink
docs: remove server side code generators that aren't built (#3138)
Browse files Browse the repository at this point in the history
* docs: remove server side code generators that aren't built

* update SDK generator pages
  • Loading branch information
dannysheridan authored Mar 11, 2024
1 parent b1e8c01 commit 11f359c
Show file tree
Hide file tree
Showing 11 changed files with 61 additions and 152 deletions.
12 changes: 0 additions & 12 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -153,18 +153,6 @@ navigation:
slug: fastapi
- page: Spring
path: ./docs/pages/fern-sdks/other-generators/server-side/spring.mdx
- page: Go
path: ./docs/pages/fern-sdks/other-generators/server-side/go.mdx
- page: DotNet
path: ./docs/pages/fern-sdks/other-generators/server-side/dotnet.mdx
slug: dotnet
- page: Ruby on Rails
path: ./docs/pages/fern-sdks/other-generators/server-side/ruby-on-rails.mdx
slug: ruby
- page: Flask
path: ./docs/pages/fern-sdks/other-generators/server-side/flask.mdx
- page: Django
path: ./docs/pages/fern-sdks/other-generators/server-side/django.mdx
- section: Specification
slug: spec
contents:
Expand Down
22 changes: 0 additions & 22 deletions fern/docs/pages/fern-sdks/other-generators/server-side/django.mdx

This file was deleted.

22 changes: 0 additions & 22 deletions fern/docs/pages/fern-sdks/other-generators/server-side/dotnet.mdx

This file was deleted.

22 changes: 0 additions & 22 deletions fern/docs/pages/fern-sdks/other-generators/server-side/flask.mdx

This file was deleted.

27 changes: 0 additions & 27 deletions fern/docs/pages/fern-sdks/other-generators/server-side/go.mdx

This file was deleted.

This file was deleted.

12 changes: 6 additions & 6 deletions fern/docs/pages/fern-sdks/sdk-generators/csharp-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@ title: The C# SDK generator
description: Use Fern's C# SDK generator and your API definition to output a fully functional C# SDK (client libraries) to your local filesystem, or publish it to NuGet.
---

Latest version: `0.0.0`

<Callout intent = "tip">
Coming by the end of the year!
Generally available in 2024! If you'd like to join the private beta, [drop us an email](mailto:[email protected]?subject=Join%20the%20C%23%20private%20beta).
</Callout>

[Source code](https://github.com/fern-api/fern/tree/main/generators/ruby)<br />
**Latest version**: `0.0.0-1`

<br />

The C# SDK generator outputs a fully functional C#
SDK. It can publish the SDK to [NuGet.org](https://www.nuget.org).
The C# SDK generator outputs a fully functional C# SDK. It can publish the SDK to [NuGet.org](https://www.nuget.org).

<CodeBlock title="generators.yml">
```yaml
- name: fernapi/fern-csharp-sdk
version: 0.0.0
version: 0.0.0-1
```
</CodeBlock>
3 changes: 1 addition & 2 deletions fern/docs/pages/fern-sdks/sdk-generators/java-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ description: Use Fern's Java SDK generator and your API definition to output a f
[Source code](https://github.com/fern-api/fern/tree/main/generators/java)<br />
**Latest version**: `0.6.1`

The Java SDK generator outputs a fully functional Java
SDK. It can publish the SDK to Maven Central (or any other Maven repository).
The Java SDK generator outputs a fully functional Java SDK. It can publish the SDK to Maven Central (or any other Maven repository).

## Local

Expand Down
7 changes: 2 additions & 5 deletions fern/docs/pages/fern-sdks/sdk-generators/php-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,17 @@ title: The PHP SDK generator
description: Use Fern's PHP SDK generator and your API definition to output a fully functional PHP SDK (client libraries) to your local filesystem, or publicly to Packagist.
---

Latest version: `0.0.0`

<Callout intent="tip">
Coming in 2024!
</Callout>

<br />

The PHP SDK generator outputs a fully functional PHP
SDK. It can publish the SDK to [Packagist.org](https://Packagist.org).
The PHP SDK generator outputs a fully functional PHP SDK. It can publish the SDK to [Packagist.org](https://Packagist.org) or to a private repository hosted by Fern.

<CodeBlock title="generators.yml">
```yaml
- name: fernapi/fern-php-sdk
version: 0.0.0
```
</CodeBlock>
</CodeBlock>
3 changes: 1 addition & 2 deletions fern/docs/pages/fern-sdks/sdk-generators/python-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ description: Use Fern's Python SDK generator and your API definition to output a
[Source code](https://github.com/fern-api/fern/tree/main/generators/python)<br />
**Latest version**: `0.8.0`

The Python SDK generator outputs a fully functional Python
SDK. It can publish the SDK to [the Python Package Index at PyPI.org](https://pypi.org) or to a private repository hosted by Fern.
The Python SDK generator outputs a fully functional Python SDK. It can publish the SDK to [the Python Package Index at PyPI.org](https://pypi.org) or to a private repository hosted by Fern.

## Local

Expand Down
61 changes: 51 additions & 10 deletions fern/docs/pages/fern-sdks/sdk-generators/ruby-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,63 @@ title: The Ruby SDK generator
description: Use Fern's Ruby SDK generator and your API definition to output a fully functional Ruby SDK (client libraries) locally, or publish it to RubyGems.
---

[Source code](https://github.com/fern-api/fern/tree/main/generators/ruby)
[Source code](https://github.com/fern-api/fern/tree/main/generators/ruby)<br />
**Latest version**: `0.3.0`

Latest version: `0.0.0`
<br />

<Callout intent="tip">
Coming by the end of the year!
</Callout>
The Ruby SDK generator outputs a fully functional Ruby SDK. It can publish the SDK to [RubyGems.org](https://RubyGems.org) or to a private repository hosted by Fern.

<br />
## Local

The Ruby SDK generator outputs a fully functional Ruby
SDK. It can publish the SDK to [RubyGems.org](https://RubyGems.org).
Dump the generated SDK to the local file system.

<CodeBlock title="generators.yml">
```yaml
- name: fernapi/fern-ruby-sdk
version: 0.0.0
groups:
local:
generators:
- name: fernapi/fern-ruby-sdk
version: 0.3.0
output:
location: local-file-system
path: ../generated/sdk/ruby
```
</CodeBlock>
## Publish an internal package
Publish the generated SDK to a private RubyGems repository hosted by Fern.
<CodeBlock title="generators.yml">
```yaml
groups:
internal:
generators:
- name: fernapi/fern-ruby-sdk
version: 0.8.0
output:
location: rubygems.buildwithfern.com
package-name: petstore # replace with your package name
```
</CodeBlock>
## Publish a public package
Publish the generated SDK to RubyGems.
<CodeBlock title="generators.yml">
```yaml
groups:
public:
generators:
- name: fernapi/fern-ruby-sdk
version: 0.3.0
output:
location: rubygems
package-name: petstore # replace with your package name
token: ${RUBYGEMS_TOKEN}
github:
repository: petstore/petstore-ruby # replace package & org
```
</CodeBlock>

0 comments on commit 11f359c

Please sign in to comment.