Initial commit

Author: ewels

.eslintrc.js

@@ -0,0 +1,33 @@
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+    node: true,
+  },
+  extends: [
+    "eslint:recommended",
+    "plugin:react/recommended",
+    "plugin:import/errors",
+    "plugin:import/warnings",
+    "plugin:@docusaurus/recommended",
+  ],
+  parserOptions: {
+    ecmaFeatures: {
+      jsx: true,
+    },
+    ecmaVersion: 12,
+    sourceType: "module",
+  },
+  plugins: ["react"],
+  rules: {
+    "react/prop-types": 0,
+  },
+  settings: {
+    "import/resolver": {
+      node: {
+        extensions: [".js", ".jsx", ".ts", ".tsx"],
+        moduleDirectory: ["node_modules", "src/"],
+      },
+    },
+  },
+};

.gitignore

@@ -0,0 +1,24 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.env
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Internal
+internal/tmp

.nvmrc

@@ -0,0 +1 @@
+18.12.0

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "tabWidth": 2,
+  "useTabs": false
+}

README.md

@@ -0,0 +1,78 @@
+# Seqera documentation
+
+This repository contains the documentation published to [docs.seqera.io](https://docs.seqera.io). We're using [Docusaurus v3](https://docusaurus.io/docs/docs-introduction), along with whichever [Remark plugins](https://docusaurus.io/docs/markdown-features/plugins) are required for our purposes.
+
+Changes merged to [master](https://github.com/seqeralabs/docs) are deployed to production automatically via Netlify. Pull requests have their own deployment preview.
+
+The source of truth for all products' documentation lives in their respective product repositories, such as [nf-tower-cloud](https://github.com/seqeralabs/nf-tower-cloud). These repositories contain a `docs` folder which house the _latest_ version of that product's documentation.
+
+Generally speaking, changes to the docs should first be made in the product repository, and then imported into this one. Exceptions may include manual fixes to earlier versions of documentation, or when updates are made to Docusaurus itself.
+
+For more information, see:
+
+- [Writing new content](#writing-new-content)
+- [Fixing legacy version content](#fixing-legacy-content)
+
+## Architecture
+
+Contentful/relevant files include:
+
+```
+├── README.md
+├── docusaurus.config.js // website config
+├── platform_versioned_docs // versioned Platform docs
+│   ├── version-22.4.0
+│   ├── version-23.1.0
+│   ├── version-23.2.0
+│   └── version-23.3.0
+├── platform_versioned_sidebars // versioned Platform sidebars
+│   ├── version-22.4.0-sidebars.json
+│   ├── version-23.1.0-sidebars.json
+│   ├── version-23.2.0-sidebars.json
+│   └── version-23.3.0-sidebars.json
+├── platform_versions.json
+└── wave_docs // unversioned Wave docs
+    ├── api.md
+    ├── cli
+    ├── faq.md
+    ├── guide.md
+    └── index.md
+```
+
+#### Seqera Platform
+
+- Content is copied to this repo from [nf-tower-cloud](https://github.com/seqeralabs/nf-tower-cloud/tree/master/docs). New contributions to Platform documentation must be made there first.
+
+- The Platform documentation is versioned and lives in the `platform_versioned_docs` directory. Each version in this directory also requires a sidebar config, which lives in the `platform_versioned_sidebars` directory. Versions also need to be specified in `platform_versions.json`. When adding a new latest version, the `docusaurus.config.js` needs to be updated as well.
+
+- We have a script which can select a commit (or ideally release tag) to be used for publishing a new version on the docs website.
+
+#### Wave
+
+- Wave documentation content is copied to this repo from [wave](https://github.com/seqeralabs/wave/tree/master/docs). New contributions to Wave documentation must be made from feature branches in `wave/docs`.
+
+- Wave documentation is unversioned, and lives in the `wave_docs` directory.
+
+## Writing new content
+
+All new content originates in the related development repository. This is the source of truth. For example, Seqera Platform documentation for new features are created in the `nf-tower-cloud` repository in the `docs` directory. A `sidebar.json` is also expected.
+
+To publish new content:
+
+1. Create a new branch in the product repo, such as `gh-issue-number`, or use an existing developer-provided work branch that includes documentation updates.
+2. Complete the necessary work.
+3. Raise a PR to merge your updates to master, requesting 2 reviews:
+   - Language review from a docs-codeowners member
+   - Technical review from the backend engineer or other SME closest to the feature
+4. Merge the PR once approved, if you created a new branch in the first step.
+
+Once merged to the master branch of the product repo, the docs content can then be copied to this repository. This can be done using the [fetch script](https://github.com/seqeralabs/docs/blob/master/internal/fetch-docs.mjs), which allows you to selected commit ID or release tag, which will be used to create a new version number on the website.
+
+## Fixing legacy content
+
+Version-specific changes to legacy documentation sets currently occur directly in this repository. Each product has a `product_versioned_docs` folder in this repository. That folder contains a subfolder for each version — edit the files in these versioned folders directly to update versioned content on docs.seqera.io:
+
+1. Create a new branch in this repository, such as `product-gh-issue-number`
+2. Create the change in the related files in the correct version (e.g., `23.1.0`) directory, and any other versions affected
+3. Raise a PR based for review, requesting the same 2 reviews as for new content
+4. After approval, merge the PR to the master branch

babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

clientside-scripts.js

@@ -0,0 +1,38 @@
+var allowedHost = 'docs.seqera.io';
+var hotjarAppID = 3836890;
+
+function canProceed() {
+  if (typeof window === 'undefined') return false;
+  if (window.location.hostname !== allowedHost) return false;
+  return true;
+}
+
+function addScripts() {
+
+  if(!canProceed()) return;
+
+  // Usersnap
+  (function usersnap() {
+    window.onUsersnapLoad = function (api) {
+      api.init();
+    };
+    var script = document.createElement("script");
+    script.defer = 1;
+    script.src =
+      "https://widget.usersnap.com/global/load/feddb12e-0a8b-45c2-86c1-56f5a9d428f6?onload=onUsersnapLoad";
+    document.getElementsByTagName("head")[0].appendChild(script);
+  })();
+
+  // HotJar
+  (function(h,o,t,j,a,r){
+    h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};
+    h._hjSettings={hjid:hotjarAppID,hjsv:6};
+    a=o.getElementsByTagName('head')[0];
+    r=o.createElement('script');r.async=1;
+    r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;
+    a.appendChild(r);
+  })(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');
+
+}
+
+addScripts();