diff options
Diffstat (limited to 'subprojects/docs')
35 files changed, 719 insertions, 9 deletions
diff --git a/subprojects/docs/docusaurus.config.ts b/subprojects/docs/docusaurus.config.ts index d0f1b33a..663c4876 100644 --- a/subprojects/docs/docusaurus.config.ts +++ b/subprojects/docs/docusaurus.config.ts | |||
@@ -5,11 +5,13 @@ | |||
5 | * SPDX-License-Identifier: MIT AND EPL-2.0 | 5 | * SPDX-License-Identifier: MIT AND EPL-2.0 |
6 | */ | 6 | */ |
7 | 7 | ||
8 | import type { Options as DocsOptions } from '@docusaurus/plugin-content-docs'; | ||
8 | import type { Options as PagesOptions } from '@docusaurus/plugin-content-pages'; | 9 | import type { Options as PagesOptions } from '@docusaurus/plugin-content-pages'; |
9 | import type { Options as ClassicThemeOptions } from '@docusaurus/theme-classic'; | 10 | import type { Options as ClassicThemeOptions } from '@docusaurus/theme-classic'; |
10 | import type { UserThemeConfig } from '@docusaurus/theme-common'; | 11 | import type { UserThemeConfig } from '@docusaurus/theme-common'; |
11 | import type { Config } from '@docusaurus/types'; | 12 | import type { Config } from '@docusaurus/types'; |
12 | import { Config as SwcConfig } from '@swc/core'; | 13 | import { Config as SwcConfig } from '@swc/core'; |
14 | import { themes } from 'prism-react-renderer'; | ||
13 | import smartypants from 'remark-smartypants'; | 15 | import smartypants from 'remark-smartypants'; |
14 | 16 | ||
15 | const markdownOptions = { | 17 | const markdownOptions = { |
@@ -18,6 +20,8 @@ const markdownOptions = { | |||
18 | 20 | ||
19 | export default { | 21 | export default { |
20 | title: 'Refinery', | 22 | title: 'Refinery', |
23 | tagline: 'An efficient graph solver for generating well-formed models', | ||
24 | titleDelimiter: '⚗️', | ||
21 | url: 'https://refinery.tools', | 25 | url: 'https://refinery.tools', |
22 | baseUrl: '/', | 26 | baseUrl: '/', |
23 | baseUrlIssueBanner: false, | 27 | baseUrlIssueBanner: false, |
@@ -25,6 +29,26 @@ export default { | |||
25 | staticDirectories: ['static'], | 29 | staticDirectories: ['static'], |
26 | plugins: [ | 30 | plugins: [ |
27 | [ | 31 | [ |
32 | '@docusaurus/plugin-content-docs', | ||
33 | { | ||
34 | id: 'docs', | ||
35 | path: 'src/docs', | ||
36 | routeBasePath: '/docs', | ||
37 | sidebarPath: undefined, | ||
38 | ...markdownOptions, | ||
39 | } satisfies DocsOptions, | ||
40 | ], | ||
41 | [ | ||
42 | '@docusaurus/plugin-content-docs', | ||
43 | { | ||
44 | id: 'api', | ||
45 | path: 'src/docs-api', | ||
46 | routeBasePath: '/api', | ||
47 | sidebarPath: undefined, | ||
48 | ...markdownOptions, | ||
49 | } satisfies DocsOptions, | ||
50 | ], | ||
51 | [ | ||
28 | '@docusaurus/plugin-content-pages', | 52 | '@docusaurus/plugin-content-pages', |
29 | markdownOptions satisfies PagesOptions, | 53 | markdownOptions satisfies PagesOptions, |
30 | ], | 54 | ], |
@@ -43,16 +67,123 @@ export default { | |||
43 | colorMode: { | 67 | colorMode: { |
44 | respectPrefersColorScheme: true, | 68 | respectPrefersColorScheme: true, |
45 | }, | 69 | }, |
70 | prism: { | ||
71 | theme: themes.oneLight, | ||
72 | darkTheme: themes.oneDark, | ||
73 | }, | ||
46 | navbar: { | 74 | navbar: { |
47 | title: 'Refinery', | 75 | title: 'Refinery', |
76 | logo: { | ||
77 | src: '/logo.svg', | ||
78 | srcDark: '/logo-dark.svg', | ||
79 | }, | ||
48 | hideOnScroll: true, | 80 | hideOnScroll: true, |
81 | items: [ | ||
82 | { | ||
83 | label: 'Learn', | ||
84 | to: '/docs', | ||
85 | }, | ||
86 | { | ||
87 | label: 'Develop', | ||
88 | to: '/api', | ||
89 | }, | ||
90 | { | ||
91 | label: 'GitHub', | ||
92 | position: 'right', | ||
93 | href: 'https://github.com/graphs4value/refinery', | ||
94 | }, | ||
95 | { | ||
96 | label: 'Try now', | ||
97 | position: 'right', | ||
98 | href: 'https://refinery.services/', | ||
99 | className: 'navbar__link--try-now', | ||
100 | }, | ||
101 | ], | ||
49 | }, | 102 | }, |
50 | footer: { | 103 | footer: { |
104 | links: [ | ||
105 | { | ||
106 | title: 'Learn', | ||
107 | items: [ | ||
108 | { | ||
109 | label: 'Introduction', | ||
110 | to: '/docs', | ||
111 | }, | ||
112 | { | ||
113 | label: 'Tutorials', | ||
114 | to: '/docs/category/tutorials', | ||
115 | }, | ||
116 | { | ||
117 | label: 'Langauge reference', | ||
118 | to: '/docs/category/language', | ||
119 | }, | ||
120 | { | ||
121 | label: 'Run in Docker', | ||
122 | to: '/docs/docker', | ||
123 | }, | ||
124 | ], | ||
125 | }, | ||
126 | { | ||
127 | title: 'Develop', | ||
128 | items: [ | ||
129 | { | ||
130 | label: 'Programming guide', | ||
131 | to: '/api', | ||
132 | }, | ||
133 | { | ||
134 | label: 'Contributing', | ||
135 | to: '/api/contributing', | ||
136 | }, | ||
137 | { | ||
138 | label: 'Javadoc', | ||
139 | to: '/api/javadoc', | ||
140 | }, | ||
141 | ], | ||
142 | }, | ||
143 | { | ||
144 | title: 'More', | ||
145 | items: [ | ||
146 | { | ||
147 | label: 'Try now', | ||
148 | href: 'https://refinery.services/', | ||
149 | }, | ||
150 | { | ||
151 | label: 'GitHub', | ||
152 | href: 'https://github.com/graphs4value/refinery', | ||
153 | }, | ||
154 | { | ||
155 | label: 'License', | ||
156 | to: '/license', | ||
157 | }, | ||
158 | ], | ||
159 | }, | ||
160 | { | ||
161 | title: 'Supporters', | ||
162 | items: [ | ||
163 | { | ||
164 | label: 'BME MIT FTSRG', | ||
165 | href: 'https://ftsrg.mit.bme.hu/en/', | ||
166 | }, | ||
167 | { | ||
168 | label: 'McGill ECE', | ||
169 | href: 'https://www.mcgill.ca/', | ||
170 | }, | ||
171 | { | ||
172 | label: '2022 Amazon Research Awards', | ||
173 | href: 'https://www.amazon.science/research-awards/recipients/daniel-varro-fall-2021', | ||
174 | }, | ||
175 | { | ||
176 | label: 'LiU Software and Systems', | ||
177 | href: 'https://liu.se/en/organisation/liu/ida/sas', | ||
178 | }, | ||
179 | ], | ||
180 | }, | ||
181 | ], | ||
51 | copyright: ` | 182 | copyright: ` |
52 | Copyright © 2021-2024 | 183 | Copyright © 2021-2024 |
53 | <a href="https://github.com/graphs4value/refinery/blob/main/CONTRIBUTORS.md" target="_blank">The Refinery Authors</a>. | 184 | <a href="https://github.com/graphs4value/refinery/blob/main/CONTRIBUTORS.md#the-refinery-authors" target="_blank">The Refinery Authors</a>. |
54 | Available under the | 185 | Available under the |
55 | <a href="https://www.eclipse.org/legal/epl-2.0/" target="_blank">Eclipse Public License - v 2.0</a>. | 186 | <a href="/license/">Eclipse Public License - v 2.0</a>. |
56 | `, | 187 | `, |
57 | }, | 188 | }, |
58 | } satisfies UserThemeConfig, | 189 | } satisfies UserThemeConfig, |
@@ -83,4 +214,57 @@ export default { | |||
83 | } satisfies SwcConfig, | 214 | } satisfies SwcConfig, |
84 | }), | 215 | }), |
85 | }, | 216 | }, |
217 | headTags: [ | ||
218 | { | ||
219 | tagName: 'link', | ||
220 | attributes: { | ||
221 | rel: 'icon', | ||
222 | href: '/favicon.svg', | ||
223 | type: 'image/svg+xml', | ||
224 | }, | ||
225 | }, | ||
226 | { | ||
227 | tagName: 'link', | ||
228 | attributes: { | ||
229 | rel: 'icon', | ||
230 | href: '/favicon.png', | ||
231 | type: 'image/png', | ||
232 | sizes: '32x32', | ||
233 | }, | ||
234 | }, | ||
235 | { | ||
236 | tagName: 'link', | ||
237 | attributes: { | ||
238 | rel: 'icon', | ||
239 | href: '/favicon-96x96.png', | ||
240 | type: 'image/png', | ||
241 | sizes: '96x96', | ||
242 | }, | ||
243 | }, | ||
244 | { | ||
245 | tagName: 'link', | ||
246 | attributes: { | ||
247 | rel: 'apple-touch-icon', | ||
248 | href: '/apple-touch-icon.png', | ||
249 | type: 'image/png', | ||
250 | sizes: '180x180', | ||
251 | }, | ||
252 | }, | ||
253 | { | ||
254 | tagName: 'meta', | ||
255 | attributes: { | ||
256 | name: 'theme-color', | ||
257 | media: '(prefers-color-scheme:light)', | ||
258 | content: '#f5f5f5', | ||
259 | }, | ||
260 | }, | ||
261 | { | ||
262 | tagName: 'meta', | ||
263 | attributes: { | ||
264 | name: 'theme-color', | ||
265 | media: '(prefers-color-scheme:dark)', | ||
266 | content: '#282c34', | ||
267 | }, | ||
268 | }, | ||
269 | ], | ||
86 | } satisfies Config; | 270 | } satisfies Config; |
diff --git a/subprojects/docs/package.json b/subprojects/docs/package.json index bdf95a70..3191c771 100644 --- a/subprojects/docs/package.json +++ b/subprojects/docs/package.json | |||
@@ -41,6 +41,8 @@ | |||
41 | "@fontsource/open-sans": "^5.0.27", | 41 | "@fontsource/open-sans": "^5.0.27", |
42 | "@mdx-js/react": "^3.0.1", | 42 | "@mdx-js/react": "^3.0.1", |
43 | "@swc/core": "^1.4.12", | 43 | "@swc/core": "^1.4.12", |
44 | "clsx": "^2.1.0", | ||
45 | "prism-react-renderer": "^2.3.1", | ||
44 | "react": "^18.2.0", | 46 | "react": "^18.2.0", |
45 | "react-dom": "^18.2.0", | 47 | "react-dom": "^18.2.0", |
46 | "remark-smartypants": "^2.1.0", | 48 | "remark-smartypants": "^2.1.0", |
diff --git a/subprojects/docs/src/css/custom.css b/subprojects/docs/src/css/custom.css index 115d7ac9..9b839f53 100644 --- a/subprojects/docs/src/css/custom.css +++ b/subprojects/docs/src/css/custom.css | |||
@@ -22,19 +22,83 @@ | |||
22 | 'Fira Code', | 22 | 'Fira Code', |
23 | monospace; | 23 | monospace; |
24 | --ifm-code-font-size: 95%; | 24 | --ifm-code-font-size: 95%; |
25 | --ifm-background-surface-color: #f5f5f5; | ||
26 | --refinery-outer-border-color: rgb(0 0 0 / 0.21); | ||
27 | --ifm-font-color-base: #19202b; | ||
28 | --ifm-color-content-secondary: #696c77; | ||
29 | --ifm-color-primary: #038a99; | ||
30 | --ifm-color-primary-dark: #037c8a; | ||
31 | --ifm-color-primary-darker: #037582; | ||
32 | --ifm-color-primary-darkest: #02616b; | ||
33 | --ifm-color-primary-light: #0398a8; | ||
34 | --ifm-color-primary-lighter: #039fb0; | ||
35 | --ifm-color-primary-lightest: #04b3c7; | ||
25 | --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); | 36 | --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); |
37 | --ifm-blockquote-color: var(--ifm-color-content-secondary); | ||
26 | } | 38 | } |
27 | 39 | ||
28 | [data-theme='dark'] { | 40 | [data-theme='dark'] { |
29 | --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); | 41 | --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); |
42 | --ifm-background-color: #21252b !important; | ||
43 | --ifm-background-surface-color: #282c34 !important; | ||
44 | --refinery-outer-border-color: transparent; | ||
45 | --ifm-font-color-base: #ebebff !important; | ||
46 | --ifm-color-content-secondary: #abb2bf !important; | ||
47 | --ifm-color-primary: #56b6c2; | ||
48 | --ifm-color-primary-dark: #43acb9; | ||
49 | --ifm-color-primary-darker: #3fa2af; | ||
50 | --ifm-color-primary-darkest: #348690; | ||
51 | --ifm-color-primary-light: #6bbfc9; | ||
52 | --ifm-color-primary-lighter: #75c3cd; | ||
53 | --ifm-color-primary-lightest: #94d1d8; | ||
30 | } | 54 | } |
31 | 55 | ||
32 | code, | 56 | code { |
33 | kbd { | ||
34 | font-feature-settings: 'liga', 'calt'; | 57 | font-feature-settings: 'liga', 'calt'; |
35 | } | 58 | } |
36 | 59 | ||
37 | .navbar__title { | 60 | .navbar { |
38 | font-weight: 500; | 61 | --ifm-navbar-background-color: var(--ifm-background-surface-color) !important; |
39 | font-size: 1.25rem; | 62 | } |
63 | |||
64 | .navbar { | ||
65 | box-shadow: 0 1px var(--refinery-outer-border-color); | ||
66 | } | ||
67 | |||
68 | [data-theme='dark'] .navbar { | ||
69 | box-shadow: var(--ifm-global-shadow-lw); | ||
70 | } | ||
71 | |||
72 | .button, .navbar__link, .footer__link-item { | ||
73 | text-transform: uppercase; | ||
74 | font-variation-settings: 'wdth' 87.5; | ||
75 | } | ||
76 | |||
77 | .button, .navbar__link { | ||
78 | font-weight: 600; | ||
79 | } | ||
80 | |||
81 | .navbar__link--try-now { | ||
82 | margin: 0 0.5rem 0 0.25rem; | ||
83 | padding: 0.25rem 1.25rem; | ||
84 | color: var(--ifm-font-color-base-inverse); | ||
85 | background: var(--ifm-color-primary); | ||
86 | border-radius: 50em; | ||
87 | transition: background var(--ifm-button-transition-duration) var(--ifm-transition-timing-default); | ||
88 | } | ||
89 | |||
90 | .navbar__link--try-now:hover { | ||
91 | color: var(--ifm-font-color-base-inverse); | ||
92 | background: var(--ifm-color-primary-dark); | ||
93 | } | ||
94 | |||
95 | .navbar__link--try-now:active { | ||
96 | color: var(--ifm-font-color-base-inverse); | ||
97 | background: var(--ifm-color-primary-darker); | ||
98 | } | ||
99 | |||
100 | .footer { | ||
101 | --ifm-footer-background-color: var(--ifm-background-surface-color) !important; | ||
102 | --ifm-footer-link-color: var(--ifm-color-content-secondary) !important; | ||
103 | box-shadow: 0 -1px var(--refinery-outer-border-color); | ||
40 | } | 104 | } |
diff --git a/subprojects/docs/src/docs-api/contributing.md b/subprojects/docs/src/docs-api/contributing.md new file mode 100644 index 00000000..4a135b81 --- /dev/null +++ b/subprojects/docs/src/docs-api/contributing.md | |||
@@ -0,0 +1,51 @@ | |||
1 | --- | ||
2 | SPDX-FileCopyrightText: 2021-2023 The Refinery Authors | ||
3 | SPDX-License-Identifier: EPL-2.0 | ||
4 | sidebar_position: 1 | ||
5 | sidebar_label: Contributing | ||
6 | --- | ||
7 | |||
8 | # Contributing to Refinery | ||
9 | |||
10 | ## Setting up the development environment | ||
11 | |||
12 | ### With IntelliJ IDEA | ||
13 | |||
14 | We prefer IntelliJ IDEA as a development environment. | ||
15 | No special preparations should be necessary for importing the project as a Gradle project into IDEA. | ||
16 | |||
17 | However, you will need Eclipse to edit Xtext (`*.xtext`) and MWE2 (`*.mwe2`) files and Ecore class diagrams (`*.aird`, `*.ecore`, `*.genmodel`). | ||
18 | If you do not plan on making changes to such files, feel free to skip the Eclipse installation steps below. | ||
19 | |||
20 | ### With Eclipse IDE | ||
21 | |||
22 | 1. Download and install a _Java 21_ compatible JDK. For Windows, prefer OpenJDK builds from [Adoptium](https://adoptium.net/). | ||
23 | |||
24 | 2. Download and extract the [Eclipse IDE for Java and DSL Developers 2023-12](https://www.eclipse.org/downloads/packages/release/2023-12/r/eclipse-ide-java-and-dsl-developers) package. | ||
25 | |||
26 | 3. Launch Eclipse and create a new workspace. | ||
27 | |||
28 | 4. Open _Help > Eclipse Marketplace_ and install the following software: | ||
29 | * _EclEmma Java Code Coverage_ | ||
30 | * _EcoreTools : Ecore Diagram Editor_ | ||
31 | * _Sirius_ (ignore the warning during installation about the solution _Sirius_ not being available) | ||
32 | * _SonarLint_ | ||
33 | |||
34 | 5. Open _Window > Preferences_ and set the following preferences: | ||
35 | * _General > Workspace > Text file encoding_ should be _UTF-8_. | ||
36 | * _General > Workspace > New text file line delimiter_ should be _Unix_. | ||
37 | * Add the JDK 21 to _Java > Installed JREs_. | ||
38 | * Make sure JDK 21 is selected for _JavaSE-21_ at _Java > Installed JREs > Execution Environments_. | ||
39 | * Set _Gradle > Java home_ to the `JAVA_HOME` directory (the directory which contains the `bin` directory) of JDK 21. Here, Buildship will show a yellow warning sign, which can be safely ignored. | ||
40 | * Set _Java > Compiler > JDK Compliance > Compiler compliance level_ to _21_. | ||
41 | |||
42 | 6. Clone the project Git repository but do not import it into Eclipse yet. | ||
43 | |||
44 | 7. Open a new terminal an run `./gradlew prepareEclipse` (`.\gradlew prepareEclipse` on Windows) in the cloned repository. | ||
45 | * This should complete without any compilation errors. | ||
46 | * If you get any errors about the JVM version, check whether the `JAVA_HOME` environment variable is set to the location of JDK. You can query the variable with `echo $JAVA_HOME` on Linux and `echo $Env:JAVA_HOME` in PowerShell on Windows. To set it, use `export JAVA_HOME=/java/path/here` or `$Env:JAVA_HOME="C:\java\path\here"`, respectively. | ||
47 | * If the build fails with a `Host name must not be empty` error, you [might need to remove the empty proxy configuration from your global `gradle.properties` file](https://stackoverflow.com/a/62128323). | ||
48 | |||
49 | 8. Select _File > Import... > Gradle > Existing Gradle Project_ and import the cloned repository in Eclipse. | ||
50 | * Make sure to select the root of the repository (containing this file) as the _Project root directory_ and that the _Gradle distribution_ is _Gradle wrapper_. | ||
51 | * If you have previously imported the project into Eclipse, this step will likely fail. In that case, you should remove the projects from Eclipse, run `git clean -fxd` in the repository, and start over from step 8. | ||
diff --git a/subprojects/docs/src/docs-api/index.md b/subprojects/docs/src/docs-api/index.md new file mode 100644 index 00000000..e87407b4 --- /dev/null +++ b/subprojects/docs/src/docs-api/index.md | |||
@@ -0,0 +1,7 @@ | |||
1 | --- | ||
2 | SPDX-FileCopyrightText: 2024 The Refinery Authors | ||
3 | SPDX-License-Identifier: EPL-2.0 | ||
4 | sidebar_position: 0 | ||
5 | --- | ||
6 | |||
7 | # Programming guide | ||
diff --git a/subprojects/docs/src/docs-api/javadoc.md b/subprojects/docs/src/docs-api/javadoc.md new file mode 100644 index 00000000..09b3e4f7 --- /dev/null +++ b/subprojects/docs/src/docs-api/javadoc.md | |||
@@ -0,0 +1,7 @@ | |||
1 | --- | ||
2 | SPDX-FileCopyrightText: 2024 The Refinery Authors | ||
3 | SPDX-License-Identifier: EPL-2.0 | ||
4 | sidebar_position: 999 | ||
5 | --- | ||
6 | |||
7 | # Javadoc | ||
diff --git a/subprojects/docs/src/docs/docker.md b/subprojects/docs/src/docs/docker.md new file mode 100644 index 00000000..c61c1457 --- /dev/null +++ b/subprojects/docs/src/docs/docker.md | |||
@@ -0,0 +1,175 @@ | |||
1 | --- | ||
2 | SPDX-FileCopyrightText: 2024 The Refinery Authors | ||
3 | SPDX-License-Identifier: EPL-2.0 | ||
4 | sidebar_position: 100 | ||
5 | sidebar_label: Docker | ||
6 | --- | ||
7 | |||
8 | # Running in Docker | ||
9 | |||
10 | :::note | ||
11 | |||
12 | Refinery can run as a cloud-based _Graph Solver as a Service_ without local installation. | ||
13 | If you're just looking to try Refinery, our [online demo](https://refinery.services/) provides a seamless experience without installation. | ||
14 | |||
15 | ::: | ||
16 | |||
17 | :::info | ||
18 | |||
19 | Installing Refinery as a Docker container can support more advanced use cases, such as when generating models with more resources or a longer timeout. | ||
20 | |||
21 | ::: | ||
22 | |||
23 | To generate larger models with a longer timeout, you can use our [Docker container](https://github.com/graphs4value/refinery/pkgs/container/refinery) on either `amd64` or `arm64` machines: | ||
24 | |||
25 | ```shell | ||
26 | docker run --rm -it -p 8888:8888 ghcr.io/graphs4value/refinery | ||
27 | ``` | ||
28 | |||
29 | Once Docker pulls and starts the container, you can navigate to http://localhost:8888 to open the model generation interface and start editing. | ||
30 | |||
31 | Alternatively, you can follow the [instructions to set up a local development environment](/api/contributing) and compile and run Refinery from source. | ||
32 | |||
33 | ## Updating | ||
34 | |||
35 | To take advantage of the latest updates, you can simply re-pull our Docker container from the GitHub Container Registry: | ||
36 | |||
37 | ```shell | ||
38 | docker pull ghcr.io/graphs4value/refinery | ||
39 | ``` | ||
40 | |||
41 | Restart the container to make sure that you're running the last pulled version. | ||
42 | |||
43 | ## Environmental variables | ||
44 | |||
45 | The Docker container supports the following environmental variables to customize its behavior. | ||
46 | Customizing these variable should only be needed if you want to _increase resource limits_ or _expose you Refinery instance over the network_ for others. | ||
47 | |||
48 | Notes for **local-only instances** are highlighted with the :arrow_right: arrow emoji. | ||
49 | |||
50 | Important security notices for **public instances** are highlighted with the :warning: warning emoji. | ||
51 | |||
52 | ### Networking | ||
53 | |||
54 | #### `REFINERY_LISTEN_HOST` | ||
55 | |||
56 | Hostname to listen at for incoming HTTP connections. | ||
57 | |||
58 | **Default value:** `0.0.0.0` (accepts connections on any IP address) | ||
59 | |||
60 | #### `REFINERY_LISTEN_PORT` | ||
61 | |||
62 | TCP port to listen at for incoming HTTP connections. | ||
63 | |||
64 | Refinery doesn't support HTTPS connections out of the box, so there's no point in setting this to `443`. Use a [reverse proxy](https://en.wikipedia.org/wiki/Reverse_proxy) instead if you wish to expose Refinery to encrypted connections. | ||
65 | |||
66 | If you change this value, don't forget to adjust the `-p 8888:8888` option of the `docker run` command to [expose](https://docs.docker.com/reference/cli/docker/container/run/#publish) the selected port. | ||
67 | |||
68 | **Default value:** `8888` | ||
69 | |||
70 | #### `REFINERY_PUBLIC_HOST` | ||
71 | |||
72 | Publicly visible hostname of the Refinery instance. | ||
73 | |||
74 | :arrow_right: For installations only accessed locally (i.e., `localhost:8888`) without any reverse proxy, you can safely leave this empty. | ||
75 | |||
76 | :warning: You should set this to the publicly visible hostname of your Refinery instance if you wish to expose Refinery over the network. Most likely, this will be the hostname of a reverse proxy that terminates TLS connections. Our online demo sets this to [refinery.services](https://refinery.services/). | ||
77 | |||
78 | **Default value:** _empty_ | ||
79 | |||
80 | #### `REFINERY_PUBLIC_PORT` | ||
81 | |||
82 | Publicly visible port of the Refinery instance. | ||
83 | |||
84 | :arrow_right: For installations only accessed locally (i.e., `localhost:8888`), this value is ignored because `REFINERY_PUBLC_HOST` is not set. | ||
85 | |||
86 | **Default value:** `443` | ||
87 | |||
88 | #### `REFINERY_ALLOWED_ORIGINS` | ||
89 | |||
90 | Comma-separated list of allowed origins for incoming WebSocket connections. If this variable is empty, all incoming WebSocket connections are accepted. | ||
91 | |||
92 | :arrow_right: For installations only accessed locally (i.e., `localhost:8888`) without any reverse proxy, you can safely leave this empty. | ||
93 | |||
94 | :warning: The value inferred from `REFINERY_PUBLIC_HOST` and `REFINERY_PUBLIC_PORT` should be suitable for instances exposed over the network. For security reasons, public instances should never leave this empty. | ||
95 | |||
96 | **Default value:** equal to `REFINERY_PUBLIC_HOST:REFINERY_PUBLIC_PORT` if they are both set, _empty_ otherwise | ||
97 | |||
98 | ### Timeouts | ||
99 | |||
100 | #### `REFINERY_SEMANTICS_TIMEOUT_MS` | ||
101 | |||
102 | Timeout for partial model semantics calculation in milliseconds. | ||
103 | |||
104 | :arrow_right: Increase this if you have a slower machine and the editor times out before showing a preview of your partial model in the _Graph_ or _Table_ views. | ||
105 | |||
106 | :warning: Increasing this timeout may increase server load. Excessively large timeout may allow users to overload you server by entering extremely complex partial models. | ||
107 | |||
108 | **Default value:** `1000` | ||
109 | |||
110 | #### `REFINERY_SEMANTICS_WARMUP_TIMEOUT_MS` | ||
111 | |||
112 | Timeout for partial model semantics calculation in milliseconds when the server first start. | ||
113 | |||
114 | Due to various initialization tasks, the first partial model semantics generation may take longer the `REFINERY_SEMANTICS_TIMEOUT_MS` and display a timeout error. This setting increases the timeout for the first generation, leading to seamless use even after server start (especially in auto-scaling setups). | ||
115 | |||
116 | **Default value:** equal to 2 × `REFINERY_SEMANTICS_TIMEOUT` | ||
117 | |||
118 | #### `REFINERY_MODEL_GENERATION_TIMEOUT_SEC` | ||
119 | |||
120 | Timeout for model generation in seconds. | ||
121 | |||
122 | :arrow_right: Adjust this value if you're generating very large models (> 10000 nodes) and need more time to complete a generation. Note that some _unsatisfiable_ model generation problems cannot be detected by Refinery and will result in model generation running for an arbitrarily long time without producing any solution. | ||
123 | |||
124 | :warning: Long running model generation will block a [_model generation thread_](#refinery_model_generation_thread_count). Try to balance the number of threads and the timeout to avoid exhausting system resources, but keep the wait time for a free model generation thread for users reasonably short. Auto-scaling to multiple instances may help with bursty demand. | ||
125 | |||
126 | **Default value:** `600` (10 minutes) | ||
127 | |||
128 | ### Threading | ||
129 | |||
130 | :warning: Excessively large values may overload the server. Make sure that _all_ Refinery threads can run at the same time to avoid thread starvation. | ||
131 | |||
132 | #### `REFINERY_XTEXT_THREAD_COUNT` | ||
133 | |||
134 | Number of threads used for non-blocking text editing operations. A value of `0` allows an _unlimited_ number of threads by running each semantics calculation in a new thread. | ||
135 | |||
136 | :warning: Excessively large values may overload the server. Make sure that _all_ Refinery threads can run at the same time to avoid thread starvation. | ||
137 | |||
138 | **Default value:** `1` | ||
139 | |||
140 | #### `REFINERY_XTEXT_LOCKING_THREAD_COUNT` | ||
141 | |||
142 | Number of threads used for text editing operations that lock the document. A value of `0` allows an _unlimited_ number of threads by running each semantics calculation in a new thread. | ||
143 | |||
144 | |||
145 | **Default value:** equal to `REFINERY_XTEXT_THREAD_COUNT` | ||
146 | |||
147 | #### `REFINERY_XTEXT_SEMANTICS_THREAD_COUNT` | ||
148 | |||
149 | Number of threads used for model semantics calculation. A value of `0` allows an _unlimited_ number of threads by running each semantics calculation in a new thread. | ||
150 | |||
151 | Must be at least as large as `REFINERY_XTEXT_THREAD_COUNT`. | ||
152 | |||
153 | :warning: Excessively large values may overload the server. Make sure that _all_ Refinery threads can run at the same time to avoid thread starvation. | ||
154 | |||
155 | **Default value:** equal to `REFINERY_XTEXT_THREAD_COUNT` | ||
156 | |||
157 | #### `REFINERY_MODEL_GENERATION_THREAD_COUNT` | ||
158 | |||
159 | Number of threads used for model semantics calculation. A value of `0` allows an _unlimited_ number of threads by running each semantics calculation in a new thread. | ||
160 | |||
161 | :warning: Excessively large values may overload the server. Make sure that _all_ Refinery threads can run at the same time to avoid thread starvation. Each model generation task may also demand a large amount of memory in addition to CPU time. | ||
162 | |||
163 | **Default value:** equal to `REFINERY_XTEXT_THREAD_COUNT` | ||
164 | |||
165 | ### Libraries | ||
166 | |||
167 | #### `REFINERY_LIBRARY_PATH` | ||
168 | |||
169 | Modules (`.refinery` files) in this directory or colon-separated list of directories will be exposed to user via Refinery's `import` mechanism. | ||
170 | |||
171 | :arrow_right: Use this in conjunction with the [mount volume (-v)](https://docs.docker.com/reference/cli/docker/container/run/#volume) option of `docker run` to work with multi-file projects in Refinery. | ||
172 | |||
173 | :warning: Make sure you only expose files that you want to make public. It's best to expose a directory that contains nothing other that `.refinery` files to minimize potential information leaks. | ||
174 | |||
175 | **Default value:** _empty_ (no directories are exposed) | ||
diff --git a/subprojects/docs/src/docs/index.md b/subprojects/docs/src/docs/index.md new file mode 100644 index 00000000..bb28df57 --- /dev/null +++ b/subprojects/docs/src/docs/index.md | |||
@@ -0,0 +1,11 @@ | |||
1 | --- | ||
2 | SPDX-FileCopyrightText: 2024 The Refinery Authors | ||
3 | SPDX-License-Identifier: EPL-2.0 | ||
4 | sidebar_position: 0 | ||
5 | --- | ||
6 | |||
7 | # Introduction | ||
8 | |||
9 | Various software and systems engineering scenarios rely on the systematic construction of consistent graph models. However, **automatically generating a diverse set of consistent graph models** for complex domain specifications is challenging. First, the graph generation problem must be specified with mathematical precision. Moreover, graph generation is a computationally complex task, which necessitates specialized logic solvers. | ||
10 | |||
11 | **Refinery is a novel open-source software framework** to automatically synthesize a diverse set of consistent domain-specific graph models. The framework offers an expressive high-level specification language using partial models to succinctly formulate a wide range of graph generation challenges. It also provides a modern cloud-based architecture for a scalable _Graph Solver as a Service,_ which uses logic reasoning rules to efficiently synthesize a diverse set of solutions to graph generation problems by partial model refinement. Applications include system-level architecture synthesis, test generation for modeling tools or traffic scenario synthesis for autonomous vehicles. | ||
diff --git a/subprojects/docs/src/docs/language/_category_.yml b/subprojects/docs/src/docs/language/_category_.yml new file mode 100644 index 00000000..7060edf3 --- /dev/null +++ b/subprojects/docs/src/docs/language/_category_.yml | |||
@@ -0,0 +1,10 @@ | |||
1 | # SPDX-FileCopyrightText: 2024 The Refinery Authors | ||
2 | # | ||
3 | # SPDX-License-Identifier: EPL-2.0 | ||
4 | |||
5 | position: 2 | ||
6 | label: Language reference | ||
7 | link: | ||
8 | type: generated-index | ||
9 | slug: /category/language | ||
10 | description: Learn more about the Refinery partial modeling language! | ||
diff --git a/subprojects/docs/src/docs/language/classes.md b/subprojects/docs/src/docs/language/classes.md new file mode 100644 index 00000000..aa569870 --- /dev/null +++ b/subprojects/docs/src/docs/language/classes.md | |||
@@ -0,0 +1,8 @@ | |||
1 | --- | ||
2 | SPDX-FileCopyrightText: 2024 The Refinery Authors | ||
3 | SPDX-License-Identifier: EPL-2.0 | ||
4 | description: Metamodeling in Refinery | ||
5 | sidebar_position: 0 | ||
6 | --- | ||
7 | |||
8 | # Classes and references | ||
diff --git a/subprojects/docs/src/docs/tutorials/_category_.yml b/subprojects/docs/src/docs/tutorials/_category_.yml new file mode 100644 index 00000000..25a06d98 --- /dev/null +++ b/subprojects/docs/src/docs/tutorials/_category_.yml | |||
@@ -0,0 +1,10 @@ | |||
1 | # SPDX-FileCopyrightText: 2024 The Refinery Authors | ||
2 | # | ||
3 | # SPDX-License-Identifier: EPL-2.0 | ||
4 | |||
5 | position: 1 | ||
6 | label: Tutorials | ||
7 | link: | ||
8 | type: generated-index | ||
9 | title: Tutorial overview | ||
10 | description: Try Refinery in practical partial modeling challenges! | ||
diff --git a/subprojects/docs/src/docs/tutorials/file-system.md b/subprojects/docs/src/docs/tutorials/file-system.md new file mode 100644 index 00000000..aed1cd87 --- /dev/null +++ b/subprojects/docs/src/docs/tutorials/file-system.md | |||
@@ -0,0 +1,9 @@ | |||
1 | --- | ||
2 | SPDX-FileCopyrightText: 2023-2024 The Refinery Authors | ||
3 | SPDX-License-Identifier: EPL-2.0 | ||
4 | description: Introduction to classes, references, and error predicates | ||
5 | sidebar_position: 0 | ||
6 | sidebar_label: File system | ||
7 | --- | ||
8 | |||
9 | # File system tutorial | ||
diff --git a/subprojects/docs/src/pages/index.module.css b/subprojects/docs/src/pages/index.module.css new file mode 100644 index 00000000..a86689d1 --- /dev/null +++ b/subprojects/docs/src/pages/index.module.css | |||
@@ -0,0 +1,11 @@ | |||
1 | /* | ||
2 | * SPDX-FileCopyrightText: 2024 The Refinery Authors | ||
3 | * | ||
4 | * SPDX-License-Identifier: EPL-2.0 | ||
5 | */ | ||
6 | |||
7 | .buttons { | ||
8 | display: flex; | ||
9 | flex-direction: row; | ||
10 | gap: 1rem; | ||
11 | } | ||
diff --git a/subprojects/docs/src/pages/index.tsx b/subprojects/docs/src/pages/index.tsx index 256d12ac..632ee3d6 100644 --- a/subprojects/docs/src/pages/index.tsx +++ b/subprojects/docs/src/pages/index.tsx | |||
@@ -4,16 +4,42 @@ | |||
4 | * SPDX-License-Identifier: EPL-2.0 | 4 | * SPDX-License-Identifier: EPL-2.0 |
5 | */ | 5 | */ |
6 | 6 | ||
7 | import Link from '@docusaurus/Link'; | ||
7 | import Layout from '@theme/Layout'; | 8 | import Layout from '@theme/Layout'; |
8 | 9 | ||
10 | import styles from './index.module.css'; | ||
11 | |||
9 | export default function Home() { | 12 | export default function Home() { |
10 | return ( | 13 | return ( |
11 | <Layout> | 14 | <Layout> |
12 | <div className="hero hero--dark"> | 15 | <header className="hero hero--dark"> |
13 | <div className="container"> | 16 | <div className="container"> |
14 | <h1 className="hero__title">Refinery</h1> | 17 | <h1 className="hero__title">Refinery</h1> |
18 | <p className="hero__subtitle"> | ||
19 | An efficient graph solver for generating well-formed models | ||
20 | </p> | ||
21 | <div className={styles['buttons']}> | ||
22 | <Link | ||
23 | href="https://refinery.services/" | ||
24 | className="button button--lg button--primary" | ||
25 | > | ||
26 | Try online | ||
27 | </Link> | ||
28 | <Link | ||
29 | to="/docs/docker" | ||
30 | className="button button--lg button--secondary" | ||
31 | > | ||
32 | Try in Docker | ||
33 | </Link> | ||
34 | <Link | ||
35 | to="/docs/tutorials/file-system" | ||
36 | className="button button--lg button--secondary" | ||
37 | > | ||
38 | Tutorial | ||
39 | </Link> | ||
40 | </div> | ||
15 | </div> | 41 | </div> |
16 | </div> | 42 | </header> |
17 | </Layout> | 43 | </Layout> |
18 | ); | 44 | ); |
19 | } | 45 | } |
diff --git a/subprojects/docs/src/pages/license.md b/subprojects/docs/src/pages/license.md new file mode 100644 index 00000000..3ce07e47 --- /dev/null +++ b/subprojects/docs/src/pages/license.md | |||
@@ -0,0 +1,100 @@ | |||
1 | --- | ||
2 | SPDX-FileCopyrightText: 2017, Eclipse.org Foundation, Inc. | ||
3 | SPDX-License-Identifier: LicenseRef-EPL-Steward | ||
4 | title: License | ||
5 | --- | ||
6 | |||
7 | # Eclipse Public License - v 2.0 | ||
8 | |||
9 | THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC LICENSE (“AGREEMENT”). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. | ||
10 | |||
11 | ## 1. DEFINITIONS | ||
12 | |||
13 | “Contribution” means: | ||
14 | |||
15 | * a) in the case of the initial Contributor, the initial content Distributed under this Agreement, and | ||
16 | * b) in the case of each subsequent Contributor: | ||
17 | * i) changes to the Program, and | ||
18 | * ii) additions to the Program; | ||
19 | where such changes and/or additions to the Program originate from and are Distributed by that particular Contributor. A Contribution “originates” from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include changes or additions to the Program that are not Modified Works. | ||
20 | |||
21 | “Contributor” means any person or entity that Distributes the Program. | ||
22 | |||
23 | “Licensed Patents” mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program. | ||
24 | |||
25 | “Program” means the Contributions Distributed in accordance with this Agreement. | ||
26 | |||
27 | “Recipient” means anyone who receives the Program under this Agreement or any Secondary License (as applicable), including Contributors. | ||
28 | |||
29 | “Derivative Works” shall mean any work, whether in Source Code or other form, that is based on (or derived from) the Program and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. | ||
30 | |||
31 | “Modified Works” shall mean any work in Source Code or other form that results from an addition to, deletion from, or modification of the contents of the Program, including, for purposes of clarity any new file in Source Code form that contains any contents of the Program. Modified Works shall not include works that contain only declarations, interfaces, types, classes, structures, or files of the Program solely in each case in order to link to, bind by name, or subclass the Program or Modified Works thereof. | ||
32 | |||
33 | “Distribute” means the acts of a) distributing or b) making available in any manner that enables the transfer of a copy. | ||
34 | |||
35 | “Source Code” means the form of a Program preferred for making modifications, including but not limited to software source code, documentation source, and configuration files. | ||
36 | |||
37 | “Secondary License” means either the GNU General Public License, Version 2.0, or any later versions of that license, including any exceptions or additional permissions as identified by the initial Contributor. | ||
38 | |||
39 | ## 2. GRANT OF RIGHTS | ||
40 | |||
41 | * a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, Distribute and sublicense the Contribution of such Contributor, if any, and such Derivative Works. | ||
42 | * b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in Source Code or other form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder. | ||
43 | * c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to Distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program. | ||
44 | * d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement. | ||
45 | * e) Notwithstanding the terms of any Secondary License, no Contributor makes additional grants to any Recipient (other than those set forth in this Agreement) as a result of such Recipient's receipt of the Program under the terms of a Secondary License (if permitted under the terms of Section 3). | ||
46 | |||
47 | ## 3. REQUIREMENTS | ||
48 | |||
49 | 3.1 If a Contributor Distributes the Program in any form, then: | ||
50 | |||
51 | * a) the Program must also be made available as Source Code, in accordance with section 3.2, and the Contributor must accompany the Program with a statement that the Source Code for the Program is available under this Agreement, and informs Recipients how to obtain it in a reasonable manner on or through a medium customarily used for software exchange; and | ||
52 | * b) the Contributor may Distribute the Program under a license different than this Agreement, provided that such license: | ||
53 | * i) effectively disclaims on behalf of all other Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose; | ||
54 | * ii) effectively excludes on behalf of all other Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits; | ||
55 | * iii) does not attempt to limit or alter the recipients' rights in the Source Code under section 3.2; and | ||
56 | * iv) requires any subsequent distribution of the Program by any party to be under a license that satisfies the requirements of this section 3. | ||
57 | |||
58 | 3.2 When the Program is Distributed as Source Code: | ||
59 | |||
60 | * a) it must be made available under this Agreement, or if the Program (i) is combined with other material in a separate file or files made available under a Secondary License, and (ii) the initial Contributor attached to the Source Code the notice described in Exhibit A of this Agreement, then the Program may be made available under the terms of such Secondary Licenses, and | ||
61 | * b) a copy of this Agreement must be included with each copy of the Program. | ||
62 | |||
63 | 3.3 Contributors may not remove or alter any copyright, patent, trademark, attribution notices, disclaimers of warranty, or limitations of liability (‘notices’) contained within the Program from any copy of the Program which they Distribute, provided that Contributors may add their own appropriate notices. | ||
64 | |||
65 | ## 4. COMMERCIAL DISTRIBUTION | ||
66 | |||
67 | Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor (“Commercial Contributor”) hereby agrees to defend and indemnify every other Contributor (“Indemnified Contributor”) against any losses, damages and costs (collectively “Losses”) arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense. | ||
68 | |||
69 | For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages. | ||
70 | |||
71 | ## 5. NO WARRANTY | ||
72 | |||
73 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations. | ||
74 | |||
75 | ## 6. DISCLAIMER OF LIABILITY | ||
76 | |||
77 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. | ||
78 | |||
79 | ## 7. GENERAL | ||
80 | |||
81 | If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable. | ||
82 | |||
83 | If Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed. | ||
84 | |||
85 | All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive. | ||
86 | |||
87 | Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. The Eclipse Foundation is the initial Agreement Steward. The Eclipse Foundation may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be Distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to Distribute the Program (including its Contributions) under the new version. | ||
88 | |||
89 | Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved. Nothing in this Agreement is intended to be enforceable by any entity that is not a Contributor or Recipient. No third-party beneficiary rights are created under this Agreement. | ||
90 | |||
91 | ## Exhibit A – Form of Secondary Licenses Notice | ||
92 | |||
93 | “This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: \{name license(s), version(s), and exceptions or additional permissions here\}.” | ||
94 | |||
95 | > Simply including a copy of this Agreement, including this Exhibit A is not sufficient to license the Source Code under Secondary Licenses. | ||
96 | > | ||
97 | > If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice. | ||
98 | > | ||
99 | > You may add additional accurate notices of copyright ownership. | ||
100 | |||
diff --git a/subprojects/docs/static/apple-touch-icon.png b/subprojects/docs/static/apple-touch-icon.png new file mode 100644 index 00000000..de8549e7 --- /dev/null +++ b/subprojects/docs/static/apple-touch-icon.png | |||
Binary files differ | |||
diff --git a/subprojects/docs/static/apple-touch-icon.png.license b/subprojects/docs/static/apple-touch-icon.png.license new file mode 100644 index 00000000..e5db6ccd --- /dev/null +++ b/subprojects/docs/static/apple-touch-icon.png.license | |||
@@ -0,0 +1,3 @@ | |||
1 | SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/> | ||
2 | |||
3 | SPDX-License-Identifier: EPL-2.0 | ||
diff --git a/subprojects/docs/static/favicon-96x96.png b/subprojects/docs/static/favicon-96x96.png new file mode 100644 index 00000000..353fe18a --- /dev/null +++ b/subprojects/docs/static/favicon-96x96.png | |||
Binary files differ | |||
diff --git a/subprojects/docs/static/favicon-96x96.png.license b/subprojects/docs/static/favicon-96x96.png.license new file mode 100644 index 00000000..e5db6ccd --- /dev/null +++ b/subprojects/docs/static/favicon-96x96.png.license | |||
@@ -0,0 +1,3 @@ | |||
1 | SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/> | ||
2 | |||
3 | SPDX-License-Identifier: EPL-2.0 | ||
diff --git a/subprojects/docs/static/favicon.png b/subprojects/docs/static/favicon.png new file mode 100644 index 00000000..18e67636 --- /dev/null +++ b/subprojects/docs/static/favicon.png | |||
Binary files differ | |||
diff --git a/subprojects/docs/static/favicon.png.license b/subprojects/docs/static/favicon.png.license new file mode 100644 index 00000000..e5db6ccd --- /dev/null +++ b/subprojects/docs/static/favicon.png.license | |||
@@ -0,0 +1,3 @@ | |||
1 | SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/> | ||
2 | |||
3 | SPDX-License-Identifier: EPL-2.0 | ||
diff --git a/subprojects/docs/static/favicon.svg b/subprojects/docs/static/favicon.svg new file mode 100644 index 00000000..b5d1d217 --- /dev/null +++ b/subprojects/docs/static/favicon.svg | |||
@@ -0,0 +1 @@ | |||
<svg width="512" height="512" xmlns="http://www.w3.org/2000/svg"><style>@media(prefers-color-scheme:dark){#a{fill:#ebebff}#b{fill:#56b6c2}}</style><path d="M447.98 179.335c-139.95-9.583-301.272-50.91-384-147.336v46.117C98.45 129.623 209.442 178.137 294.243 199.1c-84.796 20.963-195.791 69.476-230.265 120.985v46.117c82.73-96.422 244.053-137.752 384.002-147.334z" fill="#35373e" id="a"/><path d="M447.98 296.729c-113.755 4.192-287.485 40.727-384 136.557v46.716c95.14-103.612 279.898-137.754 384-143.745z" fill="#038a99" id="b"/></svg> | |||
diff --git a/subprojects/docs/static/favicon.svg.license b/subprojects/docs/static/favicon.svg.license new file mode 100644 index 00000000..e5db6ccd --- /dev/null +++ b/subprojects/docs/static/favicon.svg.license | |||
@@ -0,0 +1,3 @@ | |||
1 | SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/> | ||
2 | |||
3 | SPDX-License-Identifier: EPL-2.0 | ||
diff --git a/subprojects/docs/static/icon-192x192.png b/subprojects/docs/static/icon-192x192.png new file mode 100644 index 00000000..7c04fb37 --- /dev/null +++ b/subprojects/docs/static/icon-192x192.png | |||
Binary files differ | |||
diff --git a/subprojects/docs/static/icon-192x192.png.license b/subprojects/docs/static/icon-192x192.png.license new file mode 100644 index 00000000..e5db6ccd --- /dev/null +++ b/subprojects/docs/static/icon-192x192.png.license | |||
@@ -0,0 +1,3 @@ | |||
1 | SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/> | ||
2 | |||
3 | SPDX-License-Identifier: EPL-2.0 | ||
diff --git a/subprojects/docs/static/icon-512x512.png b/subprojects/docs/static/icon-512x512.png new file mode 100644 index 00000000..40c602c0 --- /dev/null +++ b/subprojects/docs/static/icon-512x512.png | |||
Binary files differ | |||
diff --git a/subprojects/docs/static/icon-512x512.png.license b/subprojects/docs/static/icon-512x512.png.license new file mode 100644 index 00000000..e5db6ccd --- /dev/null +++ b/subprojects/docs/static/icon-512x512.png.license | |||
@@ -0,0 +1,3 @@ | |||
1 | SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/> | ||
2 | |||
3 | SPDX-License-Identifier: EPL-2.0 | ||
diff --git a/subprojects/docs/static/icon-any.svg b/subprojects/docs/static/icon-any.svg new file mode 100644 index 00000000..3f6517b3 --- /dev/null +++ b/subprojects/docs/static/icon-any.svg | |||
@@ -0,0 +1 @@ | |||
<svg width="512" height="512" xmlns="http://www.w3.org/2000/svg"><path d="M0 0h512v512H0z" fill="#21252b"/><path d="M387.985 218.608c-96.215-6.674-207.125-35.454-264-102.609v32.118c23.698 35.87 100.005 69.657 158.306 84.257-58.297 14.599-134.606 48.385-158.307 84.258v32.117c56.876-67.153 167.786-95.936 264-102.609zm0 81.752c-78.207 2.92-197.646 28.364-264 95.103v32.535c65.409-72.159 192.43-95.936 264-100.108z" fill="#181a1f"/><path d="M387.985 202.606c-96.215-6.674-207.125-35.455-264-102.609v32.117c23.698 35.871 100.005 69.658 158.306 84.258-58.297 14.599-134.606 48.384-158.307 84.257v32.117c56.876-67.152 167.786-95.935 264-102.608z" fill="#ebebff"/><path d="M387.985 284.362c-78.207 2.92-197.646 28.364-264 95.103v32.534c65.409-72.158 192.43-95.936 264-100.108z" fill="#56b6c2"/></svg> \ No newline at end of file | |||
diff --git a/subprojects/docs/static/icon-any.svg.license b/subprojects/docs/static/icon-any.svg.license new file mode 100644 index 00000000..e5db6ccd --- /dev/null +++ b/subprojects/docs/static/icon-any.svg.license | |||
@@ -0,0 +1,3 @@ | |||
1 | SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/> | ||
2 | |||
3 | SPDX-License-Identifier: EPL-2.0 | ||
diff --git a/subprojects/docs/static/logo-dark.svg b/subprojects/docs/static/logo-dark.svg new file mode 100644 index 00000000..8f9af60d --- /dev/null +++ b/subprojects/docs/static/logo-dark.svg | |||
@@ -0,0 +1 @@ | |||
<svg width="512" height="512" xmlns="http://www.w3.org/2000/svg"><path d="M447.98 179.335c-139.95-9.583-301.272-50.91-384-147.336v46.117C98.45 129.623 209.442 178.137 294.243 199.1c-84.796 20.963-195.791 69.476-230.265 120.985v46.117c82.73-96.422 244.053-137.752 384.002-147.334z" fill="#ebebff" id="a"/><path d="M447.98 296.729c-113.755 4.192-287.485 40.727-384 136.557v46.716c95.14-103.612 279.898-137.754 384-143.745z" fill="#56b6c2" id="b"/></svg> | |||
diff --git a/subprojects/docs/static/logo-dark.svg.license b/subprojects/docs/static/logo-dark.svg.license new file mode 100644 index 00000000..a73a3364 --- /dev/null +++ b/subprojects/docs/static/logo-dark.svg.license | |||
@@ -0,0 +1,3 @@ | |||
1 | SPDX-FileCopyrightText: 2021-2024 The Refinery Authors <https://refinery.tools/> | ||
2 | |||
3 | SPDX-License-Identifier: EPL-2.0 | ||
diff --git a/subprojects/docs/static/logo.svg b/subprojects/docs/static/logo.svg new file mode 100644 index 00000000..43d302e3 --- /dev/null +++ b/subprojects/docs/static/logo.svg | |||
@@ -0,0 +1 @@ | |||
<svg width="512" height="512" xmlns="http://www.w3.org/2000/svg"><path d="M447.98 179.335c-139.95-9.583-301.272-50.91-384-147.336v46.117C98.45 129.623 209.442 178.137 294.243 199.1c-84.796 20.963-195.791 69.476-230.265 120.985v46.117c82.73-96.422 244.053-137.752 384.002-147.334z" fill="#35373e" id="a"/><path d="M447.98 296.729c-113.755 4.192-287.485 40.727-384 136.557v46.716c95.14-103.612 279.898-137.754 384-143.745z" fill="#038a99" id="b"/></svg> | |||
diff --git a/subprojects/docs/static/logo.svg.license b/subprojects/docs/static/logo.svg.license new file mode 100644 index 00000000..a73a3364 --- /dev/null +++ b/subprojects/docs/static/logo.svg.license | |||
@@ -0,0 +1,3 @@ | |||
1 | SPDX-FileCopyrightText: 2021-2024 The Refinery Authors <https://refinery.tools/> | ||
2 | |||
3 | SPDX-License-Identifier: EPL-2.0 | ||
diff --git a/subprojects/docs/static/mask-icon.svg b/subprojects/docs/static/mask-icon.svg new file mode 100644 index 00000000..86052c6e --- /dev/null +++ b/subprojects/docs/static/mask-icon.svg | |||
@@ -0,0 +1 @@ | |||
<svg width="512" height="512" xmlns="http://www.w3.org/2000/svg"><path d="M64 32v46.117c34.47 51.508 145.46 100.02 230.26 120.98C209.463 220.06 98.47 268.573 64 320.077v46.117c82.729-96.428 244.05-137.75 384-147.34v-39.531c-139.95-9.583-301.27-50.908-384-147.34zm384 264.73c-113.75 4.192-287.48 40.728-384 136.56v46.717c95.138-103.61 279.9-137.75 384-143.74v-39.529z"/></svg> | |||
diff --git a/subprojects/docs/static/mask-icon.svg.license b/subprojects/docs/static/mask-icon.svg.license new file mode 100644 index 00000000..e5db6ccd --- /dev/null +++ b/subprojects/docs/static/mask-icon.svg.license | |||
@@ -0,0 +1,3 @@ | |||
1 | SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/> | ||
2 | |||
3 | SPDX-License-Identifier: EPL-2.0 | ||