F overview

Summary

index.rst, line 16 - 20 and 30 - 32

Focus

Point the reviewer to the core of the code change. Where should they start reading? What should they focus on (e.g. security, performance, maintainability, user-friendliness, compliance with the specs, finding more corner cases, concrete questions)?

Test Environment

How to set up a test environment for manual testing?

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related issues
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

src/doc/extension/module.md

@@ -51,7 +51,7 @@ $(document).ready(function() {
     // use a variable starting with `BUILD_MODULE_` to enable your module
     // the build variable has to be enabled in the `build.properties.d/` directory.
     // Otherwise the module will not be activated.
-    if ("${BUILD_MODULE_EXT_BOTTOM_LINE}" === "ENABLED") {
+    if ("${BUILD_MODULE_EXT_FLIGHT_PREVIEW}" === "ENABLED") {
         caosdb_modules.register(ext_flight_preview);
     }
 });
@@ -88,4 +88,17 @@ may append all your module files in the desired order to the
 
     MODULE_DEPENDENCIES+=(libA.js libB.js ext_flight_preview.js)
 
-In this example, `libA.js`, `libB.js` and `ext_flight_preview.js` are custom modules developed for this particular LinkAhead webui instance.
+In this example, `libA.js`, `libB.js` and `ext_flight_preview.js` are custom modules developed for this particular CaosDB webui instance.
+
+Briefly describe the changes you made to the whole repository in the file called `CHANGELOD.md` in caosdb-webui.
+
+## Create a merge request
+
+Commit your changes to the repository to a new branch called `f-<custom name>`. `f-` is the shorthand for feature-branch and your custom name should be short, but descriptive, e.g. `f-flight-preview` in this case.
+
+Push your branch upstream using e.g.:
+`git push --set-upstream origin f-flight-preview`
+
+Login to gitlab and navigate to the project caosdb-webui.
+
+There should be a button titled `Create Merge Request`.
\ No newline at end of file