Skip to content

Commit 188f36f

Browse files
committed
Added new documentation link.
Signed-off-by: aryan <[email protected]>
1 parent c2f9713 commit 188f36f

File tree

5 files changed

+69
-50
lines changed

5 files changed

+69
-50
lines changed

README.md

+18-13
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,39 @@
55
## Adding new content to the website
66

77
### **Adding up blogs.**
8+
89
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.
910

10-
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!
11+
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!
1112

1213
### **Adding up a new feature/testimonial/sponsor.**
1314

1415
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.
1516

1617
Features in `featuresdata.ts`
17-
```(json)
18+
19+
```(json)
1820
{
19-
"color": "lighter",
20-
"title":"feature name",
21-
"description":"feature desc"
21+
"color": "lighter",
22+
"title":"feature name",
23+
"description":"feature desc"
2224
}
2325
```
26+
2427
(color here defines the shade of the container which would be rendered.)
2528

2629
Testimonials in `testimonialdata.ts`
27-
```(json)
30+
31+
```(json)
2832
{
29-
name: "meh",
30-
designation: "engineer",
31-
review: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
33+
name: "meh",
34+
designation: "engineer",
35+
review: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
3236
}
3337
```
38+
3439
Sponsors in `sponsordata.ts`
40+
3541
```
3642
{
3743
companyname: "ushfhjhb",
@@ -42,8 +48,8 @@ Sponsors in `sponsordata.ts`
4248
}
4349
```
4450

45-
4651
Faq's in `faqdata.ts`
52+
4753
```
4854
{
4955
question: "Lorem ipsum dolor sit a",
@@ -52,15 +58,14 @@ Faq's in `faqdata.ts`
5258
```
5359

5460
### **Contributor Notes**
55-
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.
5661

62+
Make sure to go through the [contribute](https://intelowlproject.github.io/docs//Contribute.html#create-a-pull-request) section here, before creating your pr.
5763

5864
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.
5965

6066
##### Run The Application locally
67+
6168
```commandline
6269
npm install
6370
npm run dev
6471
```
65-
66-

components/Header.tsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export function Header(props: Headerprops) {
3838
Features
3939
</Link>
4040
<Link
41-
href="https://intelowl.readthedocs.io/en/latest"
41+
href="https://intelowlproject.github.io/docs/"
4242
className="text-white font-SpaceGrotesk font-light text-center invisible md:visible"
4343
>
4444
Docs
@@ -104,7 +104,7 @@ export function Header(props: Headerprops) {
104104
Features
105105
</Link>
106106
<Link
107-
href="https://intelowl.readthedocs.io/en/latest"
107+
href="https://intelowlproject.github.io/docs/"
108108
className="text-white font-SpaceGrotesk font-light text-center hidden md:flex md:justify-center md:flex-row"
109109
>
110110
Docs

components/sections/HeroSection.tsx

+17-12
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/* eslint-disable @next/next/no-img-element */
44
import Link from "next/link";
55
import { motion } from "framer-motion";
6-
import { TypeAnimation } from 'react-type-animation';
6+
import { TypeAnimation } from "react-type-animation";
77

88
/* eslint-disable react/jsx-no-undef */
99
interface HeroSectionProps {
@@ -12,7 +12,16 @@ interface HeroSectionProps {
1212

1313
export default function HeroSection(props: HeroSectionProps) {
1414
const { isMobile } = props;
15-
const words = ["a hash.", 2000, "an ip.", 2000, "a malware.", 2000, "a domain.", 2000];
15+
const words = [
16+
"a hash.",
17+
2000,
18+
"an ip.",
19+
2000,
20+
"a malware.",
21+
2000,
22+
"a domain.",
23+
2000,
24+
];
1625

1726
return (
1827
<>
@@ -23,14 +32,14 @@ export default function HeroSection(props: HeroSectionProps) {
2332
>
2433
<div className="bg-inherit w-full flex flex-col items-center justify-center px-5">
2534
<h1 className="text-white text-center text-3xl leading-snug lg:leading-snug xl:leading-snug font-SpaceGrotesk font-semibold ">
26-
Get Threat Intelligence data about {" "}
35+
Get Threat Intelligence data about{" "}
2736
<span className="text-[#00ADEF]">
2837
<TypeAnimation
2938
sequence={words}
3039
preRenderFirstString={false}
3140
wrapper="span"
3241
speed={20}
33-
style={{ fontSize: '1em', display: 'inline-block' }}
42+
style={{ fontSize: "1em", display: "inline-block" }}
3443
repeat={Infinity}
3544
/>
3645
</span>
@@ -40,9 +49,7 @@ export default function HeroSection(props: HeroSectionProps) {
4049
<span className="text-[#00ADEF]">single API request.</span>
4150
</h2>
4251
<Link
43-
href={
44-
"https://intelowl.readthedocs.io/en/latest/Installation.html"
45-
}
52+
href={"https://intelowlproject.github.io/docs//Installation.html"}
4653
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"
4754
>
4855
get started ➔
@@ -70,14 +77,14 @@ export default function HeroSection(props: HeroSectionProps) {
7077
>
7178
<div className="bg-inherit w-4/6 flex flex-col items-left justify-center px-16">
7279
<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 ">
73-
Get Threat Intelligence data about {" "}
80+
Get Threat Intelligence data about{" "}
7481
<span className="text-[#00ADEF]">
7582
<TypeAnimation
7683
sequence={words}
7784
preRenderFirstString={false}
7885
wrapper="span"
7986
speed={20}
80-
style={{ fontSize: '1em', display: 'inline-block' }}
87+
style={{ fontSize: "1em", display: "inline-block" }}
8188
repeat={Infinity}
8289
/>
8390
</span>
@@ -90,9 +97,7 @@ export default function HeroSection(props: HeroSectionProps) {
9097
</span>
9198
</h2>
9299
<Link
93-
href={
94-
"https://intelowl.readthedocs.io/en/latest/Installation.html"
95-
}
100+
href={"https://intelowlproject.github.io/docs//Installation.html"}
96101
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"
97102
>
98103
get started ➔

constants/faqdata.ts

+23-19
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
export const FAQData = [
2-
{
3-
question: "How can I install IntelOwl?",
4-
answer:'That is super fast and straightforward: follow the guide <a href="https://intelowl.readthedocs.io/en/latest/Installation.html" target="_blank">here</a>'
5-
},
6-
{
7-
question: "I have several technical doubts regarding that can't just be answered at Issues. Whom I should contact? ",
8-
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>'
9-
},
10-
{
11-
question: "I have found one API / external service which can be included in IntelOwl. What next?",
12-
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.'
13-
},
14-
{
15-
question: "I would like to sponsor IntelOwl How can I do it?",
16-
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'
17-
},
18-
]
19-
20-
2+
{
3+
question: "How can I install IntelOwl?",
4+
answer:
5+
'That is super fast and straightforward: follow the guide <a href="https://intelowlproject.github.io/docs//Installation.html" target="_blank">here</a>',
6+
},
7+
{
8+
question:
9+
"I have several technical doubts regarding that can't just be answered at Issues. Whom I should contact? ",
10+
answer:
11+
'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>',
12+
},
13+
{
14+
question:
15+
"I have found one API / external service which can be included in IntelOwl. What next?",
16+
answer:
17+
'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.',
18+
},
19+
{
20+
question: "I would like to sponsor IntelOwl How can I do it?",
21+
answer:
22+
'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',
23+
},
24+
];

src/app/page.tsx

+9-4
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ export default function Home() {
6464
</span>
6565
</a>
6666
<a
67-
href="https://intelowl.readthedocs.io/en/latest/Usage.html#analyzers"
67+
href="https://intelowlproject.github.io/docs//Usage.html#analyzers"
6868
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"
6969
role="alert"
7070
>
@@ -103,7 +103,8 @@ export default function Home() {
103103
Testimonials
104104
</h2>
105105
<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">
106-
We love to work with the community to improve the project. This is what users and contributors say about IntelOwl.
106+
We love to work with the community to improve the project. This is
107+
what users and contributors say about IntelOwl.
107108
</h3>
108109
<Slider isTestimonial={true} />
109110
</section>
@@ -115,7 +116,8 @@ export default function Home() {
115116
FAQs
116117
</h2>
117118
<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 ">
118-
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
119+
Don&apos;t worry! We are here to help. In case you don&apos;t find
120+
the answer that you are looking for, feel free to contact us
119121
</h3>
120122
<FAQSection />
121123
</section>
@@ -127,7 +129,10 @@ export default function Home() {
127129
Our Sponsors
128130
</h2>
129131
<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">
130-
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!
132+
As open source project maintainers, we strongly rely on external
133+
support to get the resources and time to work on keeping the project
134+
alive, with a constant release of new features, bug fixes and
135+
general improvements. Thanks to all the following Sponsors!
131136
</h3>
132137
<Slider isTestimonial={false} />
133138
</section>

0 commit comments

Comments
 (0)