Skip to content

Commit

Permalink
Update website (#380)
Browse files Browse the repository at this point in the history
* Update website
* Update CONTRIBUTING.md
  • Loading branch information
pawelprazak authored Feb 9, 2024
1 parent 8ef9501 commit 5a08f0b
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 15 deletions.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,6 @@ as `org.virtuslab::besom-core:X.Y.Z` and `org.virtuslab::besom-<package>:A.B.C-c

Language host provider is published to Maven as `pulumi-language-scala-vX.Y.Z-OS-ARCH.tar.gz`.


To use development version of the language host provider:
```bash
pulumi --logtostderr plugin install language scala $(cat version.txt) --server github://api.github.com/VirtusLab/besom
Expand Down Expand Up @@ -220,6 +219,7 @@ just cli version update
#### Update versions in all other places

Manually update versions in all other places, specifically documentation and website, using find&replace.
Remember about `website/docusaurus.config.js:40`

Manually update branch names in all places.

Expand Down Expand Up @@ -260,6 +260,8 @@ just clean-out cli packages maven-all

Tip: it's safer to publish the packages on-by-one due to how Maven Central behaves.

In case of any issues, you can try to resolve the issues manually at https://oss.sonatype.org/index.html#stagingRepositories.

#### Finish the release

Finish the release on GitHub manually, make sure the changelog is correct and correct git tag was created.
Expand Down
20 changes: 11 additions & 9 deletions website/docs/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,13 +121,14 @@ The recommended practice is to **check stack files into source control** as a me
Since secret values are encrypted, it is safe to check in these stack settings.
:::

##### Stack information from code

You can access stack information from your [program](#programs) context using the `urn` method, e.g.:
##### Stack and project information from code

You can access Pulumi stack and project information from your [program](#programs) context using:
```scala
urn.map(_.stack) // the stack name
urn.map(_.project) // the stack name
pulumiProject // the Pulumi project name
pulumiOrganization // the Pulumi organization name
pulumiStack // the Pulumi stack name
urn // the Pulumi stack URN
```

##### Stack Outputs
Expand All @@ -140,8 +141,7 @@ To export values from a stack in Besom, use the [`Stack.exports`](exports.md) fu

##### Stack References

[Stack References](https://www.pulumi.com/docs/concepts/stack/#stackreferences) allow you to use outputs from other
[stacks](#stacks) in your [program](#programs).
[Stack References](https://www.pulumi.com/docs/concepts/stack/#stackreferences) allow you to use outputs from other [stacks](#stacks) in your [program](#programs).

To reference values from another stack, create an instance of the `StackReference` type using the fully qualified
name of the stack as an input, and then read exported stack outputs by their name.
Expand All @@ -166,8 +166,10 @@ Resources are defined using a [**resource constructor**](constructors.md). Each

```scala
val redisNamespace = Namespace(s"redis-cluster-namespace-$name")
redisNamespace.id // the physical name
redisNamespace.urn // the globally unique identifier
redisNamespace.id // the Pulumi ID - a physical name
redisNamespace.urn // the Pulumi URN - a globally unique identifier
redisNamespace.pulumiResourceName // the Pulumi resource name
redisNamespace.typeToken // the Pulumi resource type token
redisNamespace.urn.map(_.resourceName) // the logical name
redisNamespace.urn.map(_.resourceType) // the resource type
```
Expand Down
7 changes: 4 additions & 3 deletions website/docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,12 @@ When opened, both [Intellij IDEA](https://www.jetbrains.com/idea/)
and [Metals](https://scalameta.org/metals/) should automatically recognize
the project and set up the IDE accordingly.
[sbt](https://www.scala-sbt.org/) is also supported out-of-the-box but is not recommended due to
slower iteration speed. Use of sbt support is suggested for situations where managed infrastructure
[sbt](https://www.scala-sbt.org/), [gradle](https://gradle.org/) and [maven](https://maven.apache.org/) are also supported out-of-the-box,
but are **not recommended** due to slower iteration speed.
Use of `sbt`, `gradle` or `mvn` support is suggested for situations where managed infrastructure
is being added to an already existing project that uses sbt as the main build tool.
IDE setup for `sbt` works automatically with both Intellij IDEA and Metals.
IDE setup for `sbt`, `gradle` or `mvn` works automatically with both Intellij IDEA and Metals.
[Mill](https://mill-build.com/) is not yet supported.
2 changes: 1 addition & 1 deletion website/docs/missing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ title: Missing features
---

Some Pulumi features are not yet implemented. The most notable ones are:
* [Component-based packages](https://www.pulumi.com/docs/using-pulumi/pulumi-packages/how-to-author/) a.k.a. "remote components" are not yet fully available (targeted for `0.3.0` release).
* [Resource aliases](https://www.pulumi.com/docs/concepts/options/aliases/) are not yet available (targeted for `0.3.0` release).
* [Automation API](https://www.pulumi.com/docs/guides/automation-api/) is not yet available (targeted for `0.3.0` release).
* [Resource transformations](https://www.pulumi.com/docs/concepts/options/transformations/) are not yet available (targeted for `0.3.0` release).
* [State Inputs](https://github.com/VirtusLab/besom/issues/285) are not yet available (todo).
* [Dynamic Providers](https://www.pulumi.com/docs/concepts/resources/dynamic-providers/) are not yet available (researching).
* [Function serialization](https://www.pulumi.com/docs/concepts/inputs-outputs/function-serialization/) is supported only in Node.js (researching).

Expand Down
2 changes: 1 addition & 1 deletion website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ const config = {
},

customFields: {
besomVersion: '0.1.0' // TODO process.env.BESOM_VERSION
besomVersion: '0.2.0' // TODO process.env.BESOM_VERSION
},

presets: [
Expand Down

0 comments on commit 5a08f0b

Please sign in to comment.