Refactor old documentation link. (#2465)

* Refactor old documentation link. Signed-off-by: Aryan Bhokare <92683836+aryan-bhokare@users.noreply.github.com> * fix prettier test Signed-off-by: Aryan Bhokare <92683836+aryan-bhokare@users.noreply.github.com> * Fixed formatting Signed-off-by: Aryan Bhokare <92683836+aryan-bhokare@users.noreply.github.com> * Improved PE_info analyzer (#2464) * update * update * init * init * blint fix * black and flake8 * upgraded lief * complexity --------- Co-authored-by: Matteo Lodi <30625432+mlodic@users.noreply.github.com> * Fixed flake8 errors. Signed-off-by: Aryan Bhokare <92683836+aryan-bhokare@users.noreply.github.com> * [WIP] Adding docstrings in IntelOwl Codebase. (#2430) * Added docstrings in Authentication Signed-off-by: aryan <aryan1bhokare@gmail.com> * Added docstrings in api_app module. Signed-off-by: aryan <aryan1bhokare@gmail.com> * fixed linters Signed-off-by: aryan <aryan1bhokare@gmail.com> --------- Signed-off-by: aryan <aryan1bhokare@gmail.com> * fixed frontend issues * updated PR automation * Bump django-iam-dbauth from 0.1.4 to 0.2.0 in /requirements (#2476) Bumps [django-iam-dbauth](https://github.com/LabD/django-iam-dbauth) from 0.1.4 to 0.2.0. - [Release notes](https://github.com/LabD/django-iam-dbauth/releases) - [Changelog](https://github.com/labd/django-iam-dbauth/blob/main/CHANGES) - [Commits](labd/django-iam-dbauth@0.1.4...0.2.0) --- updated-dependencies: - dependency-name: django-iam-dbauth dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump checkdmarc from 5.4.0 to 5.5.0 in /requirements (#2475) Bumps [checkdmarc](https://github.com/domainaware/checkdmarc) from 5.4.0 to 5.5.0. - [Changelog](https://github.com/domainaware/checkdmarc/blob/master/CHANGELOG.md) - [Commits](https://github.com/domainaware/checkdmarc/commits) --- updated-dependencies: - dependency-name: checkdmarc dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * fixed wrong task deletion (#2477) * email cc sender (#2468) * email sender Signed-off-by: 0ssigeno <s.berni@certego.net> * Fix Signed-off-by: 0ssigeno <s.berni@certego.net> * Added case for list Signed-off-by: 0ssigeno <s.berni@certego.net> * Blake Signed-off-by: 0ssigeno <s.berni@certego.net> --------- Signed-off-by: 0ssigeno <s.berni@certego.net> * removed obsolete docker compose version * updated readme * Refactor old documentation link. Signed-off-by: Aryan Bhokare <92683836+aryan-bhokare@users.noreply.github.com> * fix prettier test Signed-off-by: Aryan Bhokare <92683836+aryan-bhokare@users.noreply.github.com> * Fixed formatting Signed-off-by: Aryan Bhokare <92683836+aryan-bhokare@users.noreply.github.com> * Fixed flake8 errors. Signed-off-by: Aryan Bhokare <92683836+aryan-bhokare@users.noreply.github.com> * linters again Signed-off-by: Aryan Bhokare <92683836+aryan-bhokare@users.noreply.github.com> --------- Signed-off-by: Aryan Bhokare <92683836+aryan-bhokare@users.noreply.github.com> Signed-off-by: aryan <aryan1bhokare@gmail.com> Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: 0ssigeno <s.berni@certego.net> Co-authored-by: Nilay Gupta <102874321+g4ze@users.noreply.github.com> Co-authored-by: Matteo Lodi <30625432+mlodic@users.noreply.github.com> Co-authored-by: Daniele Rosetti <d.rosetti@certego.net> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Federico Fantini <122294644+federicofantini@users.noreply.github.com> Co-authored-by: Simone Berni <simone.berni2@studio.unibo.it>
intelowlproject · Aug 21, 2024 · 4aa7360 · 4aa7360
1 parent 96bfb47
commit 4aa7360
Show file tree

Hide file tree

Showing 16 changed files with 66 additions and 67 deletions.
diff --git a/.github/CHANGELOG.md b/.github/CHANGELOG.md
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -1 +1 @@
-Please refer to https://intelowl.readthedocs.io/en/latest/Contribute.html
+Please refer to https://intelowlproject.github.io/docs/IntelOwl/contribute/
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -14,22 +14,22 @@ Please delete options that are not relevant.
 
 # Checklist
 
-- [ ] I have read and understood the rules about [how to Contribute](https://intelowl.readthedocs.io/en/latest/Contribute.html) to this project
+- [ ] I have read and understood the rules about [how to Contribute](https://intelowlproject.github.io/docs/IntelOwl/contribute/) to this project
 - [ ] The pull request is for the branch `develop`
 - [ ] A new plugin (analyzer, connector, visualizer, playbook, pivot or ingestor) was added or changed, in which case:
-    - [ ] I strictly followed the documentation ["How to create a Plugin"](https://intelowl.readthedocs.io/en/latest/Contribute.html#how-to-add-a-new-plugin)
+    - [ ] I strictly followed the documentation ["How to create a Plugin"](https://intelowlproject.github.io/docs/IntelOwl/contribute/#how-to-add-a-new-plugin)
     - [ ] [Usage](https://github.com/intelowlproject/docs/blob/main/docs/IntelOwl/usage.md) file was updated.
     - [ ] [Advanced-Usage](https://github.com/intelowlproject/docs/blob/main/docs/IntelOwl/advanced_usage.md) was updated (in case the plugin provides additional optional configuration).
-    - [ ] I have dumped the configuration from Django Admin using the `dumpplugin` command and added it in the project as a data migration. (["How to share a plugin with the community"](https://intelowl.readthedocs.io/en/latest/Contribute.html#how-to-share-your-plugin-with-the-community))
+    - [ ] I have dumped the configuration from Django Admin using the `dumpplugin` command and added it in the project as a data migration. (["How to share a plugin with the community"](https://intelowlproject.github.io/docs/IntelOwl/contribute/#how-to-share-your-plugin-with-the-community))
     - [ ] If a File analyzer was added and it supports a mimetype which is not already supported, you added a sample of that type inside the archive `test_files.zip` and you added the default tests for that mimetype in [test_classes.py](https://github.com/intelowlproject/IntelOwl/blob/master/tests/api_app/analyzers_manager/test_classes.py).
-    - [ ] If you created a new analyzer and it is free (does not require any API key), please add it in the `FREE_TO_USE_ANALYZERS` playbook by following [this guide](https://intelowl.readthedocs.io/en/latest/Contribute.html#how-to-modify-a-plugin).
-    - [ ] Check if it could make sense to add that analyzer/connector to other [freely available playbooks](https://intelowl.readthedocs.io/en/develop/Usage.html#list-of-pre-built-playbooks).
+    - [ ] If you created a new analyzer and it is free (does not require any API key), please add it in the `FREE_TO_USE_ANALYZERS` playbook by following [this guide](https://intelowlproject.github.io/docs/IntelOwl/contribute/#how-to-modify-a-plugin).
+    - [ ] Check if it could make sense to add that analyzer/connector to other [freely available playbooks](https://intelowlproject.github.io/docs/IntelOwl/usage/#list-of-pre-built-playbooks).
     - [ ] I have provided the resulting raw JSON of a finished analysis and a screenshot of the results.
     - [ ] If the plugin interacts with an external service, I have created an attribute called precisely `url` that contains this information. This is required for Health Checks. 
     - [ ] If the plugin requires mocked testing, `_monkeypatch()` was used in its class to apply the necessary decorators.
     - [ ] I have added that raw JSON sample to the `MockUpResponse` of the `_monkeypatch()` method. This serves us to provide a valid sample for testing.
 - [ ] If external libraries/packages with restrictive licenses were used, they were added in the [Legal Notice](https://github.com/certego/IntelOwl/blob/master/.github/legal_notice.md) section.
-- [ ] Linters (`Black`, `Flake`, `Isort`) gave 0 errors. If you have correctly installed [pre-commit](https://intelowl.readthedocs.io/en/latest/Contribute.html#how-to-start-setup-project-and-development-instance), it does these checks and adjustments on your behalf.
+- [ ] Linters (`Black`, `Flake`, `Isort`) gave 0 errors. If you have correctly installed [pre-commit](https://intelowlproject.github.io/docs/IntelOwl/contribute/#how-to-start-setup-project-and-development-instance), it does these checks and adjustments on your behalf.
 - [ ] I have added tests for the feature/bug I solved (see `tests` folder). All the tests (new and old ones) gave 0 errors.
 - [ ] If changes were made to an existing model/serializer/view, the docs were updated and regenerated (check [CONTRIBUTE.md](https://github.com/intelowlproject/IntelOwl/blob/master/docs/source/Contribute.md)).
 - [ ] If the GUI has been modified:

diff --git a/README.md b/README.md
@@ -48,11 +48,11 @@ All info about installation, usage, configuration and contribution can be found
 
 ### Publications and Media
 
-To know more about the project and its growth over time, you may be interested in reading [the official blog posts and/or videos about the project by clicking on this link](https://intelowl.readthedocs.io/en/latest/Introduction.html#publications-and-media)
+To know more about the project and its growth over time, you may be interested in reading [the official blog posts and/or videos about the project by clicking on this link](https://intelowlproject.github.io/docs/IntelOwl/introduction/#publications-and-media)
 
 ### Available services or analyzers
 
-You can see the full list of all available analyzers in the [documentation](https://intelowl.readthedocs.io/en/latest/Usage.html#available-analyzers).
+You can see the full list of all available analyzers in the [documentation](https://intelowlproject.github.io/docs/IntelOwl/usage/#analyzers).
 
 | Type                                               | Analyzers Available                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 | -------------------------------------------------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

diff --git a/api_app/analyzers_manager/file_analyzers/virushee.py b/api_app/analyzers_manager/file_analyzers/virushee.py
@@ -65,7 +65,7 @@ def __poll_status_and_result(self, task_id: str) -> dict:
         response_json = None
         url = f"{self.url}/file/task/{task_id}"
         for chance in range(self.max_tries):
-            logger.info(f"Polling try#{chance+1}")
+            logger.info(f"Polling try#{chance + 1}")
             response = self.__session.get(url)
             response.raise_for_status()
             response_json = response.json()

diff --git a/api_app/analyzers_manager/migrations/0075_adjust_greynoise.py b/api_app/analyzers_manager/migrations/0075_adjust_greynoise.py
@@ -14,8 +14,7 @@ def migrate(apps, schema_editor):
     param.save()
 
 
-def reverse_migrate(apps, schema_editor):
-    ...
+def reverse_migrate(apps, schema_editor): ...
 
 
 class Migration(migrations.Migration):

diff --git a/api_app/analyzers_manager/observable_analyzers/pulsedive.py b/api_app/analyzers_manager/observable_analyzers/pulsedive.py
@@ -93,7 +93,7 @@ def __poll_for_result(self, params):
         obj_repr = self.__repr__()
         for chance in range(self.max_tries):
             logger.info(
-                f"polling request #{chance+1} for observable: {self.observable_name}"
+                f"polling request #{chance + 1} for observable: {self.observable_name}"
                 f" <- {obj_repr}"
             )
             time.sleep(self.poll_distance)

diff --git a/api_app/ingestors_manager/ingestors/malware_bazaar.py b/api_app/ingestors_manager/ingestors/malware_bazaar.py
@@ -93,7 +93,7 @@ def run(self) -> Iterable[Any]:
         hashes_len = len(hashes)
         # download sample and create new analysis
         for idx, h in enumerate(hashes):
-            logger.info(f"Downloading sample {idx+1}/{hashes_len}")
+            logger.info(f"Downloading sample {idx + 1}/{hashes_len}")
             sample = self.download_sample(h)
             yield sample
 

diff --git a/api_app/investigations_manager/admin.py b/api_app/investigations_manager/admin.py
@@ -19,7 +19,7 @@ def total_jobs(self, instance: Investigation):
             job: Job
             tree = job.get_tree(job)
             jobs_repr = " ".join(map(str, tree.values_list("pk", flat=True)))
-            string += f"Branch {i+1}: jobs -> {jobs_repr}; "
+            string += f"Branch {i + 1}: jobs -> {jobs_repr}; "
         return string
 
     @admin.display(description="Jobs at first level")

diff --git a/api_app/playbooks_manager/signals.py b/api_app/playbooks_manager/signals.py
@@ -75,7 +75,7 @@ def m2m_changed_pivots_playbook_config(
         wrong_pivots = objects.exclude(pk__in=valid_pks)
         if wrong_pivots.exists():
             raise ValidationError(
-                f"You can't set pivot{'s' if wrong_pivots.size()> 0 else ''}"
+                f"You can't set pivot{'s' if wrong_pivots.size() > 0 else ''}"
                 f" {','.join(wrong_pivots.values_list('name', flat=True))} because"
                 " the playbook does not have all the required plugins"
             )
diff --git a/configuration/ldap_config.py b/configuration/ldap_config.py
@@ -2,7 +2,7 @@
 # See the file 'LICENSE' for copying permission.
 
 # Check the documentation for the details on how to configure LDAP
-# https://intelowl.readthedocs.io/en/latest/Advanced-Configuration.html#ldap
+# https://intelowlproject.github.io/docs/IntelOwl/advanced_configuration/#ldap
 
 import ldap
 from django_auth_ldap.config import GroupOfNamesType, LDAPSearch

diff --git a/frontend/README.md b/frontend/README.md
@@ -52,7 +52,7 @@ src/                                      source code
 The frontend inside the docker containers does not hot-reload, so
 you need to use `CRA dev server` on your host machine to serve pages when doing development on the frontend, using docker nginx only as API source.
 
-- Start IntelOwl containers (see [docs](https://intelowl.readthedocs.io/en/latest/Installation.html)). Original dockerized app is accessible on `http://localhost:80`
+- Start IntelOwl containers (see [docs](https://intelowlproject.github.io/docs/IntelOwl/installation/)). Original dockerized app is accessible on `http://localhost:80`
 
 - If you have not `node-js` installed, you have to do that. Follow the guide [here](https://www.digitalocean.com/community/tutorials/how-to-install-node-js-on-ubuntu-20-04). We tested this with NodeJS >=16.6
 

diff --git a/frontend/src/components/GuideWrapper.jsx b/frontend/src/components/GuideWrapper.jsx
@@ -17,8 +17,8 @@ export default function GuideWrapper() {
           <p>
             Welcome to IntelOwls Guide for First Time Visitors! For further
             questions you could either check out our{" "}
-            <a href="https://intelowl.readthedocs.io/en/latest/">docs</a> or
-            reach us out on{" "}
+            <a href="https://intelowlproject.github.io/docs/">docs</a> or reach
+            us out on{" "}
             <a href="https://gsoc-slack.honeynet.org/">
               the official IntelOwl slack channel
             </a>

diff --git a/frontend/src/components/plugins/types/PluginWrapper.jsx b/frontend/src/components/plugins/types/PluginWrapper.jsx
@@ -84,7 +84,7 @@ export default function PluginWrapper({
           <span className="text-muted">
             {description} Fore more info check the{" "}
             <Link
-              to="https://intelowl.readthedocs.io/en/latest/Usage.html#plugins-framework"
+              to="https://intelowlproject.github.io/docs/IntelOwl/usage/#plugins-framework"
               target="_blank"
             >
               official doc

diff --git a/frontend/src/components/scan/ScanForm.jsx b/frontend/src/components/scan/ScanForm.jsx
@@ -923,7 +923,7 @@ export default function ScanForm() {
                       <br />
                       For more info check the{" "}
                       <Link
-                        to="https://intelowl.readthedocs.io/en/latest/Usage.html#tlp-support"
+                        to="https://intelowlproject.github.io/docs/IntelOwl/usage/#tlp-support"
                         target="_blank"
                       >
                         official doc.

diff --git a/frontend/src/constants/environment.js b/frontend/src/constants/environment.js
@@ -1,5 +1,5 @@
 /* eslint-disable prefer-destructuring */
-export const INTELOWL_DOCS_URL = "https://intelowl.readthedocs.io/en/latest/";
+export const INTELOWL_DOCS_URL = "https://intelowlproject.github.io/docs/";
 export const PYINTELOWL_GH_URL =
   "https://github.com/intelowlproject/pyintelowl";
 export const INTELOWL_TWITTER_ACCOUNT = "intel_owl";