Skip to content

DOC: Schema changelog version update and remove section for global variables #1876

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nourinmohd merged 1 commit into from
Oct 5, 2026
Merged

DOC: Schema changelog version update and remove section for global variables #1876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions docs/src/custom_exports/examples/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,3 @@ The following examples are included for reference.
*
!index.md
```

## Global variables

This is a snippet of the `global_variables.yml` file which holds the static
metadata described in the [Getting Started](../../getting_started.md) section. In
real cases this file will be much longer.

```{eval-rst}
.. toggle::

.. literalinclude:: examples/fmuconfig/output/global_variables.yml
:language: yaml

```
13 changes: 10 additions & 3 deletions docs/src/datamodel/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,9 +292,10 @@ To handle this, two important concepts has been introduced.
should not change erratically, and when we need to change them, this needs to
be subject to alignment.

### Schema version changelog

{{ FmuResultsSchema.VERSION_CHANGELOG }}
:::{important}
See the [Schema version changelog](schema_changelog.md) for a complete history
of changes to the FMU results schema.
:::

### Contractual attributes

Expand All @@ -316,6 +317,12 @@ Expand below to see a full example of valid metadata for surface exported from F

You will find more examples in [fmu-dataio github repository](https://github.com/equinor/fmu-dataio/tree/main/examples/0.8.0).

```{toctree}
:hidden:

schema_changelog.md
```


## FAQ

Expand Down
5 changes: 5 additions & 0 deletions docs/src/datamodel/schema_changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Schema version changelog

This page contains the complete version history for the FMU results schema.

{{ FmuResultsSchema.VERSION_CHANGELOG.replace("#### ", "## ") }}
Loading