Added new documentation link.

Signed-off-by: aryan <[email protected]>
intelowlproject · Aug 15, 2024 · 188f36f · 188f36f
1 parent c2f9713
commit 188f36f
Show file tree

Hide file tree

Showing 5 changed files with 69 additions and 50 deletions.
diff --git a/README.md b/README.md
@@ -5,33 +5,39 @@
 ## Adding new content to the website
 
 ### **Adding up blogs.**
+
 Add your article as a new markdown file in the [Blogs directory](https://github.com/intelowlproject/intelowlproject.github.io/tree/develop/Blogs) with the same title as the file.
 
-If you are an IntelOwl contributor and you would like to add content on this blog which is related to IntelOwl, feel free to fork this repository and submit an article! We will review it and publish it! 
+If you are an IntelOwl contributor and you would like to add content on this blog which is related to IntelOwl, feel free to fork this repository and submit an article! We will review it and publish it!
 
 ### **Adding up a new feature/testimonial/sponsor.**
 
 In [Constants folder](https://github.com/intelowlproject/intelowlproject.github.io/tree/develop/constants), you can add the content for specific section in thier specific file in form of these json objects, no need to scour the codebase.
 
 Features in `featuresdata.ts`
- ```(json)
+
+```(json)
 {
-        "color": "lighter",
-        "title":"feature name",
-        "description":"feature desc"
+       "color": "lighter",
+       "title":"feature name",
+       "description":"feature desc"
 }
 ```
+
 (color here defines the shade of the container which would be rendered.)
 
 Testimonials in `testimonialdata.ts`
- ```(json)
+
+```(json)
 {
-        name: "meh",
-        designation: "engineer",
-        review: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."  
+       name: "meh",
+       designation: "engineer",
+       review: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
 }
 ```
+
 Sponsors in `sponsordata.ts`
+
 ```
 {
         companyname: "ushfhjhb",
@@ -42,8 +48,8 @@ Sponsors in `sponsordata.ts`
 }
 ```
 
-
 Faq's in `faqdata.ts`
+
 ```
 {
         question: "Lorem ipsum dolor sit a",
@@ -52,15 +58,14 @@ Faq's in `faqdata.ts`
 ```
 
 ### **Contributor Notes**
-Make sure to go through the [contribute](https://intelowl.readthedocs.io/en/latest/Contribute.html#create-a-pull-request) section here, before creating your pr.
 
+Make sure to go through the [contribute](https://intelowlproject.github.io/docs//Contribute.html#create-a-pull-request) section here, before creating your pr.
 
 While testing any markdown related changes, if you run into any issue, you can do `npx --no-install contentlayer build` to generate the contentlayer content yourself, through your vscode terminal.
 
 ##### Run The Application locally
+
 ```commandline
 npm install
 npm run dev
 ```
-
-
diff --git a/components/Header.tsx b/components/Header.tsx
@@ -38,7 +38,7 @@ export function Header(props: Headerprops) {
               Features
             </Link>
             <Link
-              href="https://intelowl.readthedocs.io/en/latest"
+              href="https://intelowlproject.github.io/docs/"
               className="text-white font-SpaceGrotesk font-light text-center invisible md:visible"
             >
               Docs
@@ -104,7 +104,7 @@ export function Header(props: Headerprops) {
               Features
             </Link>
             <Link
-              href="https://intelowl.readthedocs.io/en/latest"
+              href="https://intelowlproject.github.io/docs/"
               className="text-white font-SpaceGrotesk font-light text-center hidden md:flex md:justify-center md:flex-row"
             >
               Docs

diff --git a/components/sections/HeroSection.tsx b/components/sections/HeroSection.tsx
@@ -3,7 +3,7 @@
 /* eslint-disable @next/next/no-img-element */
 import Link from "next/link";
 import { motion } from "framer-motion";
-import { TypeAnimation } from 'react-type-animation';
+import { TypeAnimation } from "react-type-animation";
 
 /* eslint-disable react/jsx-no-undef */
 interface HeroSectionProps {
@@ -12,7 +12,16 @@ interface HeroSectionProps {
 
 export default function HeroSection(props: HeroSectionProps) {
   const { isMobile } = props;
-  const words = ["a hash.", 2000, "an ip.", 2000, "a malware.", 2000, "a domain.", 2000];
+  const words = [
+    "a hash.",
+    2000,
+    "an ip.",
+    2000,
+    "a malware.",
+    2000,
+    "a domain.",
+    2000,
+  ];
 
   return (
     <>
@@ -23,14 +32,14 @@ export default function HeroSection(props: HeroSectionProps) {
         >
           <div className="bg-inherit w-full flex flex-col items-center justify-center px-5">
             <h1 className="text-white text-center text-3xl leading-snug lg:leading-snug xl:leading-snug font-SpaceGrotesk font-semibold ">
-              Get Threat Intelligence data about {" "}
+              Get Threat Intelligence data about{" "}
               <span className="text-[#00ADEF]">
                 <TypeAnimation
                   sequence={words}
                   preRenderFirstString={false}
                   wrapper="span"
                   speed={20}
-                  style={{ fontSize: '1em', display: 'inline-block' }}
+                  style={{ fontSize: "1em", display: "inline-block" }}
                   repeat={Infinity}
                 />
               </span>
@@ -40,9 +49,7 @@ export default function HeroSection(props: HeroSectionProps) {
               <span className="text-[#00ADEF]">single API request.</span>
             </h2>
             <Link
-              href={
-                "https://intelowl.readthedocs.io/en/latest/Installation.html"
-              }
+              href={"https://intelowlproject.github.io/docs//Installation.html"}
               className=" transform transition-transform duration-3 hover:scale-110 btn bg-[#00ADEE] hover:bg-blue-700 text-white py-2 mb-12 px-4 text-sm rounded w-32 h-10 mt-8 font-SpaceGrotesk text-center"
             >
               get started ➔
@@ -70,14 +77,14 @@ export default function HeroSection(props: HeroSectionProps) {
         >
           <div className="bg-inherit w-4/6 flex flex-col items-left justify-center px-16">
             <h1 className="text-white text-left text-5xl lg:text-6xl xl:text-7xl leading-snug lg:leading-snug xl:leading-snug font-SpaceGrotesk font-semibold ">
-              Get Threat Intelligence data about {" "}
+              Get Threat Intelligence data about{" "}
               <span className="text-[#00ADEF]">
                 <TypeAnimation
                   sequence={words}
                   preRenderFirstString={false}
                   wrapper="span"
                   speed={20}
-                  style={{ fontSize: '1em', display: 'inline-block' }}
+                  style={{ fontSize: "1em", display: "inline-block" }}
                   repeat={Infinity}
                 />
               </span>
@@ -90,9 +97,7 @@ export default function HeroSection(props: HeroSectionProps) {
               </span>
             </h2>
             <Link
-              href={
-                "https://intelowl.readthedocs.io/en/latest/Installation.html"
-              }
+              href={"https://intelowlproject.github.io/docs//Installation.html"}
               className="transform transition-transform duration-3 hover:scale-110 btn bg-[#00ADEE] hover:bg-blue-700 text-white py-2 px-4 rounded w-36 h-10 mt-16 font-SpaceGrotesk text-center"
             >
               get started ➔

diff --git a/constants/faqdata.ts b/constants/faqdata.ts
@@ -1,20 +1,24 @@
 export const FAQData = [
-    {
-        question: "How can I install IntelOwl?",
-        answer:'That is super fast and straightforward: follow the guide <a href="https://intelowl.readthedocs.io/en/latest/Installation.html" target="_blank">here</a>'
-    },
-    {
-        question: "I have several technical doubts regarding that can't just be answered at Issues. Whom I should contact? ",
-        answer:'Join our <a href="https://gsoc-slack.honeynet.org/" target="_blank" >Slack community</a> where all our Development goes on. Otherwise you can contact the authors via the <a href="https://twitter.com/intel_owl" target="_blank" >official IntelOwl Twitter account</a>'
-    },
-    {
-        question: "I have found one API / external service which can be included in IntelOwl. What next?",
-        answer:'Great! Head over to <a href="https://github.com/intelowlproject/IntelOwl/issues" >GitHub Issues</a> and open a new one. Contribute to it if you wish, else just leave it there. Rest of things will be taken care of by us.'
-    },
-    {
-        question: "I would like to sponsor IntelOwl How can I do it?",
-        answer:'Great! You can go towards the <a href="https://opencollective.com/intelowl-project/donate" target="_blank">Open Collective site</a> and choose how much you would like to contribute! Even a little donation is really meaningful for us! If you are a company, please remember that the donation can be deducted from taxes because, thanks to Open Collective, we have the same legal status of a non-profit association'
-    },
-]
-
-
+  {
+    question: "How can I install IntelOwl?",
+    answer:
+      'That is super fast and straightforward: follow the guide <a href="https://intelowlproject.github.io/docs//Installation.html" target="_blank">here</a>',
+  },
+  {
+    question:
+      "I have several technical doubts regarding that can't just be answered at Issues. Whom I should contact? ",
+    answer:
+      'Join our <a href="https://gsoc-slack.honeynet.org/" target="_blank" >Slack community</a> where all our Development goes on. Otherwise you can contact the authors via the <a href="https://twitter.com/intel_owl" target="_blank" >official IntelOwl Twitter account</a>',
+  },
+  {
+    question:
+      "I have found one API / external service which can be included in IntelOwl. What next?",
+    answer:
+      'Great! Head over to <a href="https://github.com/intelowlproject/IntelOwl/issues" >GitHub Issues</a> and open a new one. Contribute to it if you wish, else just leave it there. Rest of things will be taken care of by us.',
+  },
+  {
+    question: "I would like to sponsor IntelOwl How can I do it?",
+    answer:
+      'Great! You can go towards the <a href="https://opencollective.com/intelowl-project/donate" target="_blank">Open Collective site</a> and choose how much you would like to contribute! Even a little donation is really meaningful for us! If you are a company, please remember that the donation can be deducted from taxes because, thanks to Open Collective, we have the same legal status of a non-profit association',
+  },
+];
diff --git a/src/app/page.tsx b/src/app/page.tsx
@@ -64,7 +64,7 @@ export default function Home() {
               </span>
             </a>
             <a
-              href="https://intelowl.readthedocs.io/en/latest/Usage.html#analyzers"
+              href="https://intelowlproject.github.io/docs//Usage.html#analyzers"
               className="transform transition-transform duration-3 hover:scale-105 inline-flex justify-between items-center py-1 px-1 pr-4 mb-7 text-sm text-gray-700 bg-gray-100 rounded-full dark:bg-gray-800 dark:text-white hover:bg-gray-200 dark:hover:bg-gray-700"
               role="alert"
             >
@@ -103,7 +103,8 @@ export default function Home() {
             Testimonials
           </h2>
           <h3 className="text-center md:w-2/3 mx-6 text-white text-lg md:text-2xl lg:text-2xl xl:text-3xl leading-snug lg:leading-snug xl:leading-snug font-SpaceGrotesk font-light opacity-70 mt-2">
-            We love to work with the community to improve the project. This is what users and contributors say about IntelOwl.
+            We love to work with the community to improve the project. This is
+            what users and contributors say about IntelOwl.
           </h3>
           <Slider isTestimonial={true} />
         </section>
@@ -115,7 +116,8 @@ export default function Home() {
             FAQs
           </h2>
           <h3 className="text-center md:w-2/3 mx-6 text-white text-lg md:text-2xl lg:text-2xl xl:text-3xl leading-snug lg:leading-snug xl:leading-snug font-SpaceGrotesk font-light opacity-70 mt-2  mb-5 ">
-            Don&apos;t worry! We are here to help. In case you don&apos;t find the answer that you are looking for, feel free to contact us
+            Don&apos;t worry! We are here to help. In case you don&apos;t find
+            the answer that you are looking for, feel free to contact us
           </h3>
           <FAQSection />
         </section>
@@ -127,7 +129,10 @@ export default function Home() {
             Our Sponsors
           </h2>
           <h3 className="text-center md:w-2/3 mx-6 text-white text-lg md:text-xl lg:text-xl xl:text-2xl leading-snug lg:leading-snug xl:leading-snug font-SpaceGrotesk font-light opacity-70 mt-2">
-            As open source project maintainers, we strongly rely on external support to get the resources and time to work on keeping the project alive, with a constant release of new features, bug fixes and general improvements. Thanks to all the following Sponsors!
+            As open source project maintainers, we strongly rely on external
+            support to get the resources and time to work on keeping the project
+            alive, with a constant release of new features, bug fixes and
+            general improvements. Thanks to all the following Sponsors!
           </h3>
           <Slider isTestimonial={false} />
         </section>