Skip to content

Commit c20278e

Browse files
GMishxGMishx
committed
chore(repo): Initial docusaurus commit
Signed-off-by: Gaurav Mishra <[email protected]>
1 parent 1384af1 commit c20278e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+10347
-6
lines changed

‎.github/workflows/deploy.yml

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# SPDX-License-Identifier: MIT
2+
#
3+
# SPDX-FileCopyrightText: 2021 Gaurav Mishra <[email protected]>
4+
# SPDX-FileCopyrightText: 2021 Siemens AG
5+
6+
name: Test and deploy
7+
8+
on:
9+
pull_request:
10+
branches: [main]
11+
push:
12+
branches: [main]
13+
14+
jobs:
15+
checks:
16+
if: github.event_name != 'push'
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v2
20+
- uses: actions/setup-node@v2
21+
with:
22+
node-version: 12
23+
- name: Test Build
24+
run: |
25+
if [ -e yarn.lock ]; then
26+
yarn install --frozen-lockfile
27+
elif [ -e package-lock.json ]; then
28+
npm ci
29+
else
30+
npm i
31+
fi
32+
npm run build
33+
gh-release:
34+
if: github.event_name != 'pull_request'
35+
runs-on: ubuntu-latest
36+
steps:
37+
- uses: actions/checkout@v2
38+
- uses: actions/setup-node@v2
39+
with:
40+
node-version: 12
41+
- name: Build pages
42+
run: |
43+
# git config --global user.email "[email protected]"
44+
# git config --global user.name "gh-actions"
45+
if [ -e yarn.lock ]; then
46+
yarn install --frozen-lockfile
47+
elif [ -e package-lock.json ]; then
48+
npm ci
49+
else
50+
npm i
51+
fi
52+
yarn build
53+
- name: Release to GitHub Pages
54+
uses: JamesIves/[email protected]
55+
with:
56+
branch: gh-pages
57+
folder: build

‎.gitignore

+22-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,22 @@
1-
_site/
2-
.sass-cache/
3-
.jekyll-cache/
4-
.jekyll-metadata
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*
21+
22+
tags

‎LICENSE

+193
Large diffs are not rendered by default.

‎README.md

+31-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,31 @@
1-
# gsoc-2021
2-
Updates and reports about FOSSology's GSoC 2021 projects
1+
# GSoC @ FOSSology
2+
3+
This repository is created to hold every documentation generated during GSoC seasons for FOSSology project.
4+
5+
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
6+
7+
## Installation
8+
9+
```console
10+
yarn install
11+
```
12+
13+
## Local Development
14+
15+
```console
16+
yarn start
17+
```
18+
19+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
20+
21+
## Build
22+
23+
```console
24+
yarn build
25+
```
26+
27+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
28+
29+
## Deployment
30+
31+
Once the branch is merged to `main` branch, it will be deployed with the help of Github Actions at https://fossology.github.io/gsoc/ .

‎babel.config.js

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

‎blog/2021-06-23-cmake-w3.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
slug: /cmake-cweek3
3+
title: New build system - Week 3
4+
author: Avinal
5+
author_title: Build system
6+
author_url: https://github.com/avinal/
7+
author_image_url: https://avatars.githubusercontent.com/u/74113200?v=4
8+
tags: [coding-week, cmake]
9+
---
10+
<!--
11+
SPDX-License-Identifier: CC-BY-SA-4.0
12+
13+
SPDX-FileCopyrightText: 2021 Avinal Kumar <[email protected]>
14+
-->
15+
16+
# Coding Week 3 Meeting
17+
18+
### Attendees
19+
20+
- Michael C. Jaeger https://github.com/mcjaeger
21+
- Gaurav Mishra https://github.com/GMishx
22+
- Sarita Singh https://github.com/itssingh
23+
- Avinal Kumar https://github.com/avinal
24+
25+
### Week 2 Progress
26+
27+
1. Version file Implementation
28+
2. Initial functions on obtaining commit and branch info
29+
3. To test the current progress, follow the instructions [here](https://github.com/avinal/FOSSology/wiki#test-the-new-system-only-gcc-with-make-and-ninja-tested-for-now)
30+
31+
<!--truncate-->
32+
33+
### Discussions
34+
35+
* **What is the regex expression used for obtaining version information?**
36+
37+
- The regex has recently been modified to cover recent versions. The latest form is as below:
38+
```cpp
39+
([[:digit:]]+.[[:digit:]]+.[[:digit:]]+)(-?rc[[:digit:]]+)?-?([[:digit:]]*)-?[[:alnum:]]*
40+
```
41+
- You can also try alternatives to regex if possible for CMake.
42+
43+
* **Should I use** `git describe --tags` **or** `git describe --always HEAD` **for obtaining version information?**
44+
- In FOSSology we always use :code:`git describe --tags`, no exception whatsoever.
45+
46+
* CMake provides a preset configuration for the install path on GNU systems, you can see the description [here](https://cmake.org/cmake/help/v3.10/module/GNUInstallDirs.html) based on the [configuration](https://www.gnu.org/prep/standards/html_node/Directory-Variables.html) suggested by the GNU. After comparing the variables defined in Makefile.conf with these, it seems directly taken from GNU standards.
47+
So I wanted to ask if this would be okay to stick to the presets, instead of manually declaring the same paths? The former step will reduce the number of variables we are currently caching and will make it flexible for different installation scenarios.
48+
49+
- Using the GNU standards is the ideal situation but FOSSology uses slightly different locations. For example, all agents end up under `/usr/local/share/fossology/` with their individual folders instead of going to `/usr/local/bin/`.
50+
- If the same results can be achieved by using the `CMAKE_INSTALL_<dir>` and `CMAKE_INSTALL_PREFIX` then yeah, it will be preferred.
51+
52+
### Conclusion and Further Plans
53+
54+
* Try adding the version and commit hash info.
55+
* Implement writing version files for each build.

‎docs/2021/buildsystem/_category_.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "New build system",
3+
"position": 2
4+
}

‎docs/2021/buildsystem/build.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
sidebar_position: 3
3+
title: Building FOSSology
4+
---
5+
<!--
6+
SPDX-License-Identifier: CC-BY-SA-4.0
7+
8+
SPDX-FileCopyrightText: 2021 Avinal Kumar <[email protected]>
9+
-->
10+
11+
1. Clone the project
12+
2. Install cmake
13+
- `sudo apt install cmake`
14+
3. Configure the build system
15+
- ```bash
16+
mkdir build
17+
cd build
18+
cmake ..
19+
```
20+
4. Compile
21+
- `make`
22+
5. Install
23+
- `make install`

‎docs/2021/buildsystem/index.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
sidebar_position: 1
3+
title: Introduction
4+
slug: /2021/buildsystem/
5+
---
6+
<!--
7+
SPDX-License-Identifier: CC-BY-SA-4.0
8+
9+
SPDX-FileCopyrightText: 2021 Avinal Kumar <[email protected]>
10+
-->
11+
12+
A brief introduction about the project, what is the aim and what is the
13+
proposed plan.
14+
15+
Check out [Building FOSSology](build) to know how to build FOSSology with
16+
CMake.

‎docs/2021/buildsystem/updates/2021-06-23.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: Week 3
3+
author: Avinal
4+
---
5+
<!--
6+
SPDX-License-Identifier: CC-BY-SA-4.0
7+
8+
SPDX-FileCopyrightText: 2021 Avinal Kumar <[email protected]>
9+
-->
10+
11+
# Coding Week 3 Meeting
12+
13+
### Attendees
14+
15+
- Michael C. Jaeger https://github.com/mcjaeger
16+
- Gaurav Mishra https://github.com/GMishx
17+
- Sarita Singh https://github.com/itssingh
18+
- Avinal Kumar https://github.com/avinal
19+
20+
### Week 2 Progress
21+
22+
1. Version file Implementation
23+
2. Initial functions on obtaining commit and branch info
24+
3. To test the current progress, follow the instructions [here](https://github.com/avinal/FOSSology/wiki#test-the-new-system-only-gcc-with-make-and-ninja-tested-for-now)
25+
26+
### Discussions
27+
28+
* **What is the regex expression used for obtaining version information?**
29+
30+
- The regex has recently been modified to cover recent versions. The latest form is as below:
31+
```cpp
32+
([[:digit:]]+.[[:digit:]]+.[[:digit:]]+)(-?rc[[:digit:]]+)?-?([[:digit:]]*)-?[[:alnum:]]*
33+
```
34+
- You can also try alternatives to regex if possible for CMake.
35+
36+
* **Should I use** `git describe --tags` **or** `git describe --always HEAD` **for obtaining version information?**
37+
- In FOSSology we always use :code:`git describe --tags`, no exception whatsoever.
38+
39+
* CMake provides a preset configuration for the install path on GNU systems, you can see the description [here](https://cmake.org/cmake/help/v3.10/module/GNUInstallDirs.html) based on the [configuration](https://www.gnu.org/prep/standards/html_node/Directory-Variables.html) suggested by the GNU. After comparing the variables defined in Makefile.conf with these, it seems directly taken from GNU standards.
40+
So I wanted to ask if this would be okay to stick to the presets, instead of manually declaring the same paths? The former step will reduce the number of variables we are currently caching and will make it flexible for different installation scenarios.
41+
42+
- Using the GNU standards is the ideal situation but FOSSology uses slightly different locations. For example, all agents end up under `/usr/local/share/fossology/` with their individual folders instead of going to `/usr/local/bin/`.
43+
- If the same results can be achieved by using the `CMAKE_INSTALL_<dir>` and `CMAKE_INSTALL_PREFIX` then yeah, it will be preferred.
44+
45+
### Conclusion and Further Plans
46+
47+
* Try adding the version and commit hash info.
48+
* Implement writing version files for each build.

‎docs/2021/buildsystem/updates/_category_.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Weekly Updates",
3+
"position": 2
4+
}

‎docs/2021/copyrights/_category_.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Copyrights false positive detection",
3+
"position": 3
4+
}

‎docs/2021/copyrights/index.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
sidebar_position: 1
3+
title: Introduction
4+
slug: /2021/copyrights/
5+
---
6+
<!--
7+
SPDX-License-Identifier: CC-BY-SA-4.0
8+
9+
SPDX-FileCopyrightText: 2021 Kaushlendra Pratap <[email protected]>
10+
-->
11+
12+
A brief introduction about the project, what is the aim and what is the
13+
proposed plan.
14+
15+
Check out how to [setup](setup) the project.

‎docs/2021/copyrights/setup.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
sidebar_position: 3
3+
title: Setup
4+
---
5+
<!--
6+
SPDX-License-Identifier: CC-BY-SA-4.0
7+
8+
SPDX-FileCopyrightText: 2021 Kaushlendra Pratap <[email protected]>
9+
-->
10+
11+
Something about setting up the project.

‎docs/2021/copyrights/updates/2021-07-05.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Week 2
3+
author: Kaushlendra
4+
---
5+
<!--
6+
SPDX-License-Identifier: CC-BY-SA-4.0
7+
8+
SPDX-FileCopyrightText: 2021 Kaushlendra Pratap <[email protected]>
9+
-->
10+
11+
# Coding Week 2 Meeting
12+
13+
### Attendees
14+
15+
### Week 2 Progress
16+
17+
### Discussions
18+
19+
### Conclusion and Further Plans

‎docs/2021/copyrights/updates/_category_.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Weekly Updates",
3+
"position": 2
4+
}

‎docs/2021/index.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
sidebar_position: 1
3+
title: GSoC'21 @ FOSSology
4+
slug: /2021
5+
---
6+
<!--
7+
SPDX-License-Identifier: CC-BY-SA-4.0
8+
9+
SPDX-FileCopyrightText: 2021 Gaurav Mishra <[email protected]>
10+
SPDX-FileCopyrightText: 2021 Siemens AG
11+
-->
12+
13+
2021 is the 4th time FOSSology has participated in
14+
[Google Summer of Code](https://summerofcode.withgoogle.com/organizations/6095425418821632/).
15+
16+
This year, we have 7 amazing students working with us and spending their summer
17+
contributing to the Open Souce.
18+
19+
### Projects
20+
Following are the links to their projects
21+
22+
| Student | Project |
23+
| :--- | :--- |
24+
| [Aman Dwivedi](https://github.com/Aman-Codes) | [React UI](/docs/2021/ui) |
25+
| [Avinal Kumar](https://github.com/avinal) | [New Build System](/docs/2021/buildsystem) |
26+
| [Kaushlendra Pratap Singh](https://github.com/Kaushl2208) | [Copyright False Positive detection](/docs/2021/copyrights) |
27+
| [Omar AbdelSamea](https://github.com/OmarAbdelSamea) | [New Build System](/docs/2021/microservice) |
28+
| [Sarita Singh](https://github.com/itssingh) | [ScanCode Integration](/docs/2021/scancode) |
29+
| [Shreya Singh](https://github.com/SinghShreya05) | [Minerva](/docs/2021/minerva) |
30+
| [Shruti Agarwal](https://github.com/shruti3004) | [React UI](/docs/2021/ui) |
31+
32+
These links (also on the left sidebar) contains information about the project,
33+
the weekly updates from the students and even technical documentation which
34+
were generated during the Google Summer of Code.
35+
36+
### Mentors
37+
38+
* [Anupam Ghosh](https://github.com/ag4ums)
39+
* [Gaurav Mishra](https://github.com/GMishx)
40+
* [Shaheem Azmal](https://github.com/shaheemazmalmmd)
41+
* [Michael Jaeger](https://github.com/mcjaeger)
42+
* [Vivek Kumar](https://github.com/viv9k)
43+
* [Nicolas Toussaint](https://github.com/NicolasToussaint)
44+
* [Sashil Jha](https://github.com/sjha2048)
45+
* [Ayush Bhardwaj](https://github.com/hastagAB)
46+
* [Vasudev Maduri](https://github.com/vasudevmaduri)
47+
* Klaus Gmeinwieser

‎docs/2021/microservice/_category_.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Microservice architecture",
3+
"position": 4
4+
}

0 commit comments

Comments
 (0)