Skip to content

Commit 7682d42

Browse files
updating docs
1 parent 8af82f4 commit 7682d42

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,5 @@ Reexport = "1.2.2"
3434
Serialization = "1.10.4"
3535
Sockets = "1.10.4"
3636
TOML = "1.0.3"
37-
Test = "1.11.0"
37+
Test = "1.11.0"
3838
YAML = "0.4.12"

docs/src/index.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,15 @@ _CloudClusters.jl_ assumes that the user has configured their credentials for th
2525
Creating clusters with _CloudClusters.jl_ requires specifying some configuration parameters. By default, they are specified in a file named _CCconfig.toml_ that is searched in the following locations, in this order:
2626
* a path pointed by the CLOUD_CLUSTERS_CONFIG environment variable, if it exists;
2727
* the current path.
28-
28+
29+
Section [Configuration parameters](https://github.com/PlatformAwareProgramming/CloudClusters.jl#configuration-parameters) describes configuration parameters and how they can be overridden in programs.
30+
2931
Default configuration parameters can be overridden in programs.
3032

31-
Section [Configuration parameters](https://github.com/PlatformAwareProgramming/CloudClusters.jl#configuration-parameters) describes configuration parameters and how they can be overridden in programs.
33+
A [_CCconfig.toml_](https://raw.githubusercontent.com/PlatformAwareProgramming/CloudClusters.jl/refs/heads/main/CCconfig.toml) file is provided in the repository's top-level directory. It is configured to create clusters using prebuilt virtual machine images for each supported cloud provider. These images are based on the latest version of Ubuntu and include a Julia installation of a recent stable version with all the packages needed to instantiate the clusters added and precompiled. Users can create customized images, possibly derived from the provided image, using their preferred version of Julia and adding the packages they need.
34+
35+
> [!NOTE]
36+
> The version of Julia on the host computer using _CloudClusters.jl_ must be the same version as the image used to deploy the clusters.
3237
3338
### The _PlatformAware.jl_ package
3439

@@ -192,7 +197,7 @@ julia> @nodes my_second_cluster
192197
12
193198
13
194199
195-
julia> @nodes my_third_cluster
200+
julia> @ nodes my_third_cluster
196201
8-element Vector{Int64}
197202
14
198203
15

0 commit comments

Comments
 (0)