Compare commits
174 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
63ab0e12b2
|
|||
|
df4f2e3863
|
|||
|
f03f57f064
|
|||
|
4f942563c1
|
|||
|
f5e739494a
|
|||
|
5f467665bc
|
|||
|
99f3fb5ec8
|
|||
|
5fa9a10203
|
|||
|
f613005a23
|
|||
| 6bd1a2d648 | |||
| 6e7b3c86ee | |||
| cda0b2e6be | |||
| 19784d18ee | |||
| 5420886a23 | |||
| 924b449301 | |||
|
9dd8b56aaa
|
|||
| ef70634b2a | |||
| 6b07ea345f | |||
|
62efd95607
|
|||
|
1bb34a512a
|
|||
|
84d922ffdf
|
|||
|
ac07c6d551
|
|||
|
7de0552895
|
|||
|
9fed144245
|
|||
| 8a7416e5b9 | |||
|
7a3399a795
|
|||
|
0dbf1345c5
|
|||
|
26d4777488
|
|||
|
1b32720c8c
|
|||
|
775ed4cb2a
|
|||
| 01c8389e7f | |||
|
35ec52b22f
|
|||
|
1e13894242
|
|||
| 31a90cd19c | |||
| c36e86ba2f | |||
|
05c967c5a8
|
|||
|
d2c0f902d1
|
|||
|
d085c84d03
|
|||
|
91d3d5df19
|
|||
|
c8a95c9706
|
|||
|
4bcef023c0
|
|||
|
8d88cf03c4
|
|||
|
a196ac4391
|
|||
|
1c20213cd4
|
|||
|
5a21dd69a8
|
|||
|
e9ab9932be
|
|||
|
3145afbf52
|
|||
|
f9d2b58db3
|
|||
|
046ad24d97
|
|||
|
26a9b72dff
|
|||
|
531a3c7f55
|
|||
|
ce8f46553c
|
|||
|
222be5e44d
|
|||
|
c7da3e3388
|
|||
|
77ef0f8191
|
|||
|
2f0037ac98
|
|||
|
38bcfeead3
|
|||
|
1168062168
|
|||
|
a2cff8b6e0
|
|||
|
2afb4b65b8
|
|||
|
0bb902369f
|
|||
|
047aeb0b86
|
|||
| f4c5db16d2 | |||
| 8836b83c27 | |||
|
da864f840d
|
|||
|
6365554a4f
|
|||
|
a14f70123f
|
|||
|
5ebdf00472
|
|||
|
660f227a8f
|
|||
|
97fdd892d5
|
|||
|
b5cea84e4d
|
|||
|
82d2b002e0
|
|||
|
4d49130e9c
|
|||
| fcf7bc3ed3 | |||
| 421bb616ec | |||
| b20d3de614 | |||
| 35dc64bbbf | |||
| b14eadbd6e | |||
| 05e332c727 | |||
| 656e8277f9 | |||
| 2d6f7f929f | |||
| 1fd232f751 | |||
| 0851835bc9 | |||
| 79ce59b499 | |||
| e6753e137d | |||
| 8e3d4b408f | |||
| 7e8dd5cdea | |||
| 50c630733a | |||
| 22fec59069 | |||
| 5194c4bacd | |||
| 85c3881dcd | |||
| 921f5ee883 | |||
| 7f4e4f5938 | |||
| 11bff197f6 | |||
| eae6b0d3f7 | |||
| 6ddc56d3a7 | |||
| dbd1dfec3a | |||
| c8b58f6080 | |||
| c483f30cea | |||
| c44d451467 | |||
| 3d99bcf3a9 | |||
| b827a4b0f9 | |||
| c2adcaec6c | |||
| 9a88c34745 | |||
| 43e157885f | |||
| beb5acf322 | |||
| 961c1897c1 | |||
| 87f2c7c2fa | |||
| 9947b7580e | |||
| 4d7ab38808 | |||
| 1317e9249b | |||
| 97f9a6e955 | |||
| 2abc42b79e | |||
| e266508040 | |||
| d0a2e82884 | |||
| 6e163ae9e1 | |||
| 9133b0ebea | |||
| 6ee5f2f0bc | |||
| 0b78d7a3e1 | |||
| 28e6888a11 | |||
| 239c67da1c | |||
| 0097117553 | |||
| de9debbb5d | |||
| 4882b60bde | |||
| 9b27f45e00 | |||
| eb0f825244 | |||
| 398a09d301 | |||
| fe325ca25a | |||
| 3840e00bec | |||
| e46f0dfbbe | |||
| 0a97668317 | |||
| cda5e8288d | |||
| c64a15fef5 | |||
| 770e809bd2 | |||
| a68c0354d4 | |||
| 2a66c43f5e | |||
| f15f4b825f | |||
| a6e6a4a3ba | |||
| c1570d2b7f | |||
| c954347451 | |||
| f325dafde1 | |||
| 6e8570edb2 | |||
| 38febf8727 | |||
| 9baef63a2e | |||
| b0bcd5794e | |||
| e6e5a939f3 | |||
| 2ba5689a76 | |||
| e41f2e4520 | |||
| abe8d6ee20 | |||
| d71d020d85 | |||
| 5fd42929ae | |||
| 65fe4eb7a1 | |||
| 0e331cd41f | |||
| d30b69bac0 | |||
| 8ac581d3a0 | |||
| 914ec4c0b6 | |||
| f52ca5f7e4 | |||
| d949aab083 | |||
| bab11c32bd | |||
| 5e539dadaf | |||
| 80a054c8c0 | |||
| 291a44de09 | |||
| 68cbbdee1f | |||
| f19dba4ef8 | |||
| 038cc78441 | |||
| 42d6fed355 | |||
| e21a03d871 | |||
| 7d6693ffbd | |||
| 9b550b4eb9 | |||
| 47f946dde7 | |||
| 48f7b5907f | |||
| 00effc7c33 | |||
| 5e2c452665 | |||
| faa6d37ad9 |
@@ -0,0 +1,7 @@
|
||||
# No environment variables required.
|
||||
# All external data is fetched from public APIs or configured in src/config/theme.ts.
|
||||
#
|
||||
# WakaTime: public share URL (configured in src/lib/wakatime.ts)
|
||||
# GitHub: public API (configured in src/lib/github.ts)
|
||||
# ListenBrainz: public API, username in src/config/theme.ts
|
||||
# Cal.com: embedded via CDN script (configured in src/pages/meeting.astro)
|
||||
@@ -1,11 +0,0 @@
|
||||
# To get started with Dependabot version updates, you'll need to specify which
|
||||
# package ecosystems to update and where the package manifests are located.
|
||||
# Please see the documentation for all configuration options:
|
||||
# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
|
||||
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: "pip" # See documentation for possible values
|
||||
directory: "/" # Location of package manifests
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
@@ -0,0 +1,31 @@
|
||||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: ["main"]
|
||||
pull_request:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 22
|
||||
cache: "npm"
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Audit dependencies
|
||||
run: npm audit --audit-level=high
|
||||
continue-on-error: true
|
||||
|
||||
- name: Check types
|
||||
run: npm run check
|
||||
|
||||
- name: Build site
|
||||
run: npm run build
|
||||
@@ -1,31 +0,0 @@
|
||||
# This is a basic workflow to help you get started with Actions
|
||||
|
||||
name: Publish Blog
|
||||
|
||||
# Controls when the action will run. Triggers the workflow on push or pull request
|
||||
# events but only for the main branch
|
||||
on:
|
||||
push:
|
||||
branches: [ main ]
|
||||
pull_request:
|
||||
branches: [ main ]
|
||||
|
||||
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
|
||||
jobs:
|
||||
# This workflow contains a single job called "build"
|
||||
build:
|
||||
# The type of runner that the job will run on
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
# Steps represent a sequence of tasks that will be executed as part of the job
|
||||
steps:
|
||||
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
# Runs a single command using the runners shell
|
||||
- name: set up permissions
|
||||
run: chmod +x pages-publish.sh
|
||||
|
||||
# Runs a set of commands using the runners shell
|
||||
- name: Run a multi-line script
|
||||
run: ./pages-publish.sh
|
||||
@@ -1,5 +1,21 @@
|
||||
# build folders
|
||||
output
|
||||
__pycache__
|
||||
*.txt
|
||||
.vscode
|
||||
# Dependencies
|
||||
node_modules/
|
||||
|
||||
# Build output
|
||||
dist/
|
||||
.astro/
|
||||
|
||||
# Environment
|
||||
.env
|
||||
.env.local
|
||||
.env.production
|
||||
|
||||
# IDE
|
||||
.idea/
|
||||
.vscode/
|
||||
|
||||
# OS
|
||||
.DS_Store
|
||||
|
||||
# Personal files
|
||||
Profile.pdf
|
||||
|
||||
@@ -1,38 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Lost in Space!</title>
|
||||
<meta name="description" content="Somewhere out there beneath the pale moon light...">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="author" content="Avinal">
|
||||
<link rel="stylesheet" href="https://avinal.space/custom/css/space404.css" />
|
||||
<link rel='stylesheet' href='https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.2.0/css/font-awesome.min.css'>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div class='description' align=center>
|
||||
<h1>ME CHERCHEZ-VOUS?</h1>
|
||||
|
||||
<p class='links' align=center>
|
||||
<a class='fa fa-github-alt icon' href='https://github.com/avinal' target='_blank'></a>
|
||||
<a class='fa fa-mail-forward icon' href='mailto:avinal.xlvii@gmail.com' target='_blank'></a>
|
||||
</p>
|
||||
</div>
|
||||
<div class='solar-syst'>
|
||||
<div class='sun'></div>
|
||||
<div class='mercury'></div>
|
||||
<div class='venus'></div>
|
||||
<div class='earth'></div>
|
||||
<div class='mars'></div>
|
||||
<div class='jupiter'></div>
|
||||
<div class='saturn'></div>
|
||||
<div class='uranus'></div>
|
||||
<div class='neptune'></div>
|
||||
<div class='pluto'></div>
|
||||
<div class='asteroids-belt'></div>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
@@ -1,407 +1,27 @@
|
||||
Attribution-NonCommercial 4.0 International
|
||||
MIT License
|
||||
|
||||
=======================================================================
|
||||
Copyright (c) 2024-present Avinal Kumar
|
||||
|
||||
Creative Commons Corporation ("Creative Commons") is not a law firm and
|
||||
does not provide legal services or legal advice. Distribution of
|
||||
Creative Commons public licenses does not create a lawyer-client or
|
||||
other relationship. Creative Commons makes its licenses and related
|
||||
information available on an "as-is" basis. Creative Commons gives no
|
||||
warranties regarding its licenses, any material licensed under their
|
||||
terms and conditions, or any related information. Creative Commons
|
||||
disclaims all liability for damages resulting from their use to the
|
||||
fullest extent possible.
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
Using Creative Commons Public Licenses
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
Creative Commons public licenses provide a standard set of terms and
|
||||
conditions that creators and other rights holders may use to share
|
||||
original works of authorship and other material subject to copyright
|
||||
and certain other rights specified in the public license below. The
|
||||
following considerations are for informational purposes only, are not
|
||||
exhaustive, and do not form part of our licenses.
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
Considerations for licensors: Our public licenses are
|
||||
intended for use by those authorized to give the public
|
||||
permission to use material in ways otherwise restricted by
|
||||
copyright and certain other rights. Our licenses are
|
||||
irrevocable. Licensors should read and understand the terms
|
||||
and conditions of the license they choose before applying it.
|
||||
Licensors should also secure all rights necessary before
|
||||
applying our licenses so that the public can reuse the
|
||||
material as expected. Licensors should clearly mark any
|
||||
material not subject to the license. This includes other CC-
|
||||
licensed material, or material used under an exception or
|
||||
limitation to copyright. More considerations for licensors:
|
||||
wiki.creativecommons.org/Considerations_for_licensors
|
||||
---
|
||||
|
||||
Considerations for the public: By using one of our public
|
||||
licenses, a licensor grants the public permission to use the
|
||||
licensed material under specified terms and conditions. If
|
||||
the licensor's permission is not necessary for any reason--for
|
||||
example, because of any applicable exception or limitation to
|
||||
copyright--then that use is not regulated by the license. Our
|
||||
licenses grant only permissions under copyright and certain
|
||||
other rights that a licensor has authority to grant. Use of
|
||||
the licensed material may still be restricted for other
|
||||
reasons, including because others have copyright or other
|
||||
rights in the material. A licensor may make special requests,
|
||||
such as asking that all changes be marked or described.
|
||||
Although not required by our licenses, you are encouraged to
|
||||
respect those requests where reasonable. More considerations
|
||||
for the public:
|
||||
wiki.creativecommons.org/Considerations_for_licensees
|
||||
|
||||
=======================================================================
|
||||
|
||||
Creative Commons Attribution-NonCommercial 4.0 International Public
|
||||
License
|
||||
|
||||
By exercising the Licensed Rights (defined below), You accept and agree
|
||||
to be bound by the terms and conditions of this Creative Commons
|
||||
Attribution-NonCommercial 4.0 International Public License ("Public
|
||||
License"). To the extent this Public License may be interpreted as a
|
||||
contract, You are granted the Licensed Rights in consideration of Your
|
||||
acceptance of these terms and conditions, and the Licensor grants You
|
||||
such rights in consideration of benefits the Licensor receives from
|
||||
making the Licensed Material available under these terms and
|
||||
conditions.
|
||||
|
||||
|
||||
Section 1 -- Definitions.
|
||||
|
||||
a. Adapted Material means material subject to Copyright and Similar
|
||||
Rights that is derived from or based upon the Licensed Material
|
||||
and in which the Licensed Material is translated, altered,
|
||||
arranged, transformed, or otherwise modified in a manner requiring
|
||||
permission under the Copyright and Similar Rights held by the
|
||||
Licensor. For purposes of this Public License, where the Licensed
|
||||
Material is a musical work, performance, or sound recording,
|
||||
Adapted Material is always produced where the Licensed Material is
|
||||
synched in timed relation with a moving image.
|
||||
|
||||
b. Adapter's License means the license You apply to Your Copyright
|
||||
and Similar Rights in Your contributions to Adapted Material in
|
||||
accordance with the terms and conditions of this Public License.
|
||||
|
||||
c. Copyright and Similar Rights means copyright and/or similar rights
|
||||
closely related to copyright including, without limitation,
|
||||
performance, broadcast, sound recording, and Sui Generis Database
|
||||
Rights, without regard to how the rights are labeled or
|
||||
categorized. For purposes of this Public License, the rights
|
||||
specified in Section 2(b)(1)-(2) are not Copyright and Similar
|
||||
Rights.
|
||||
d. Effective Technological Measures means those measures that, in the
|
||||
absence of proper authority, may not be circumvented under laws
|
||||
fulfilling obligations under Article 11 of the WIPO Copyright
|
||||
Treaty adopted on December 20, 1996, and/or similar international
|
||||
agreements.
|
||||
|
||||
e. Exceptions and Limitations means fair use, fair dealing, and/or
|
||||
any other exception or limitation to Copyright and Similar Rights
|
||||
that applies to Your use of the Licensed Material.
|
||||
|
||||
f. Licensed Material means the artistic or literary work, database,
|
||||
or other material to which the Licensor applied this Public
|
||||
License.
|
||||
|
||||
g. Licensed Rights means the rights granted to You subject to the
|
||||
terms and conditions of this Public License, which are limited to
|
||||
all Copyright and Similar Rights that apply to Your use of the
|
||||
Licensed Material and that the Licensor has authority to license.
|
||||
|
||||
h. Licensor means the individual(s) or entity(ies) granting rights
|
||||
under this Public License.
|
||||
|
||||
i. NonCommercial means not primarily intended for or directed towards
|
||||
commercial advantage or monetary compensation. For purposes of
|
||||
this Public License, the exchange of the Licensed Material for
|
||||
other material subject to Copyright and Similar Rights by digital
|
||||
file-sharing or similar means is NonCommercial provided there is
|
||||
no payment of monetary compensation in connection with the
|
||||
exchange.
|
||||
|
||||
j. Share means to provide material to the public by any means or
|
||||
process that requires permission under the Licensed Rights, such
|
||||
as reproduction, public display, public performance, distribution,
|
||||
dissemination, communication, or importation, and to make material
|
||||
available to the public including in ways that members of the
|
||||
public may access the material from a place and at a time
|
||||
individually chosen by them.
|
||||
|
||||
k. Sui Generis Database Rights means rights other than copyright
|
||||
resulting from Directive 96/9/EC of the European Parliament and of
|
||||
the Council of 11 March 1996 on the legal protection of databases,
|
||||
as amended and/or succeeded, as well as other essentially
|
||||
equivalent rights anywhere in the world.
|
||||
|
||||
l. You means the individual or entity exercising the Licensed Rights
|
||||
under this Public License. Your has a corresponding meaning.
|
||||
|
||||
|
||||
Section 2 -- Scope.
|
||||
|
||||
a. License grant.
|
||||
|
||||
1. Subject to the terms and conditions of this Public License,
|
||||
the Licensor hereby grants You a worldwide, royalty-free,
|
||||
non-sublicensable, non-exclusive, irrevocable license to
|
||||
exercise the Licensed Rights in the Licensed Material to:
|
||||
|
||||
a. reproduce and Share the Licensed Material, in whole or
|
||||
in part, for NonCommercial purposes only; and
|
||||
|
||||
b. produce, reproduce, and Share Adapted Material for
|
||||
NonCommercial purposes only.
|
||||
|
||||
2. Exceptions and Limitations. For the avoidance of doubt, where
|
||||
Exceptions and Limitations apply to Your use, this Public
|
||||
License does not apply, and You do not need to comply with
|
||||
its terms and conditions.
|
||||
|
||||
3. Term. The term of this Public License is specified in Section
|
||||
6(a).
|
||||
|
||||
4. Media and formats; technical modifications allowed. The
|
||||
Licensor authorizes You to exercise the Licensed Rights in
|
||||
all media and formats whether now known or hereafter created,
|
||||
and to make technical modifications necessary to do so. The
|
||||
Licensor waives and/or agrees not to assert any right or
|
||||
authority to forbid You from making technical modifications
|
||||
necessary to exercise the Licensed Rights, including
|
||||
technical modifications necessary to circumvent Effective
|
||||
Technological Measures. For purposes of this Public License,
|
||||
simply making modifications authorized by this Section 2(a)
|
||||
(4) never produces Adapted Material.
|
||||
|
||||
5. Downstream recipients.
|
||||
|
||||
a. Offer from the Licensor -- Licensed Material. Every
|
||||
recipient of the Licensed Material automatically
|
||||
receives an offer from the Licensor to exercise the
|
||||
Licensed Rights under the terms and conditions of this
|
||||
Public License.
|
||||
|
||||
b. No downstream restrictions. You may not offer or impose
|
||||
any additional or different terms or conditions on, or
|
||||
apply any Effective Technological Measures to, the
|
||||
Licensed Material if doing so restricts exercise of the
|
||||
Licensed Rights by any recipient of the Licensed
|
||||
Material.
|
||||
|
||||
6. No endorsement. Nothing in this Public License constitutes or
|
||||
may be construed as permission to assert or imply that You
|
||||
are, or that Your use of the Licensed Material is, connected
|
||||
with, or sponsored, endorsed, or granted official status by,
|
||||
the Licensor or others designated to receive attribution as
|
||||
provided in Section 3(a)(1)(A)(i).
|
||||
|
||||
b. Other rights.
|
||||
|
||||
1. Moral rights, such as the right of integrity, are not
|
||||
licensed under this Public License, nor are publicity,
|
||||
privacy, and/or other similar personality rights; however, to
|
||||
the extent possible, the Licensor waives and/or agrees not to
|
||||
assert any such rights held by the Licensor to the limited
|
||||
extent necessary to allow You to exercise the Licensed
|
||||
Rights, but not otherwise.
|
||||
|
||||
2. Patent and trademark rights are not licensed under this
|
||||
Public License.
|
||||
|
||||
3. To the extent possible, the Licensor waives any right to
|
||||
collect royalties from You for the exercise of the Licensed
|
||||
Rights, whether directly or through a collecting society
|
||||
under any voluntary or waivable statutory or compulsory
|
||||
licensing scheme. In all other cases the Licensor expressly
|
||||
reserves any right to collect such royalties, including when
|
||||
the Licensed Material is used other than for NonCommercial
|
||||
purposes.
|
||||
|
||||
|
||||
Section 3 -- License Conditions.
|
||||
|
||||
Your exercise of the Licensed Rights is expressly made subject to the
|
||||
following conditions.
|
||||
|
||||
a. Attribution.
|
||||
|
||||
1. If You Share the Licensed Material (including in modified
|
||||
form), You must:
|
||||
|
||||
a. retain the following if it is supplied by the Licensor
|
||||
with the Licensed Material:
|
||||
|
||||
i. identification of the creator(s) of the Licensed
|
||||
Material and any others designated to receive
|
||||
attribution, in any reasonable manner requested by
|
||||
the Licensor (including by pseudonym if
|
||||
designated);
|
||||
|
||||
ii. a copyright notice;
|
||||
|
||||
iii. a notice that refers to this Public License;
|
||||
|
||||
iv. a notice that refers to the disclaimer of
|
||||
warranties;
|
||||
|
||||
v. a URI or hyperlink to the Licensed Material to the
|
||||
extent reasonably practicable;
|
||||
|
||||
b. indicate if You modified the Licensed Material and
|
||||
retain an indication of any previous modifications; and
|
||||
|
||||
c. indicate the Licensed Material is licensed under this
|
||||
Public License, and include the text of, or the URI or
|
||||
hyperlink to, this Public License.
|
||||
|
||||
2. You may satisfy the conditions in Section 3(a)(1) in any
|
||||
reasonable manner based on the medium, means, and context in
|
||||
which You Share the Licensed Material. For example, it may be
|
||||
reasonable to satisfy the conditions by providing a URI or
|
||||
hyperlink to a resource that includes the required
|
||||
information.
|
||||
|
||||
3. If requested by the Licensor, You must remove any of the
|
||||
information required by Section 3(a)(1)(A) to the extent
|
||||
reasonably practicable.
|
||||
|
||||
4. If You Share Adapted Material You produce, the Adapter's
|
||||
License You apply must not prevent recipients of the Adapted
|
||||
Material from complying with this Public License.
|
||||
|
||||
|
||||
Section 4 -- Sui Generis Database Rights.
|
||||
|
||||
Where the Licensed Rights include Sui Generis Database Rights that
|
||||
apply to Your use of the Licensed Material:
|
||||
|
||||
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
|
||||
to extract, reuse, reproduce, and Share all or a substantial
|
||||
portion of the contents of the database for NonCommercial purposes
|
||||
only;
|
||||
|
||||
b. if You include all or a substantial portion of the database
|
||||
contents in a database in which You have Sui Generis Database
|
||||
Rights, then the database in which You have Sui Generis Database
|
||||
Rights (but not its individual contents) is Adapted Material; and
|
||||
|
||||
c. You must comply with the conditions in Section 3(a) if You Share
|
||||
all or a substantial portion of the contents of the database.
|
||||
|
||||
For the avoidance of doubt, this Section 4 supplements and does not
|
||||
replace Your obligations under this Public License where the Licensed
|
||||
Rights include other Copyright and Similar Rights.
|
||||
|
||||
|
||||
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
|
||||
|
||||
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
|
||||
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
|
||||
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
|
||||
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
|
||||
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
|
||||
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
|
||||
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
|
||||
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
|
||||
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
|
||||
|
||||
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
|
||||
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
|
||||
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
|
||||
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
|
||||
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
|
||||
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
|
||||
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
|
||||
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
|
||||
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
|
||||
|
||||
c. The disclaimer of warranties and limitation of liability provided
|
||||
above shall be interpreted in a manner that, to the extent
|
||||
possible, most closely approximates an absolute disclaimer and
|
||||
waiver of all liability.
|
||||
|
||||
|
||||
Section 6 -- Term and Termination.
|
||||
|
||||
a. This Public License applies for the term of the Copyright and
|
||||
Similar Rights licensed here. However, if You fail to comply with
|
||||
this Public License, then Your rights under this Public License
|
||||
terminate automatically.
|
||||
|
||||
b. Where Your right to use the Licensed Material has terminated under
|
||||
Section 6(a), it reinstates:
|
||||
|
||||
1. automatically as of the date the violation is cured, provided
|
||||
it is cured within 30 days of Your discovery of the
|
||||
violation; or
|
||||
|
||||
2. upon express reinstatement by the Licensor.
|
||||
|
||||
For the avoidance of doubt, this Section 6(b) does not affect any
|
||||
right the Licensor may have to seek remedies for Your violations
|
||||
of this Public License.
|
||||
|
||||
c. For the avoidance of doubt, the Licensor may also offer the
|
||||
Licensed Material under separate terms or conditions or stop
|
||||
distributing the Licensed Material at any time; however, doing so
|
||||
will not terminate this Public License.
|
||||
|
||||
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
|
||||
License.
|
||||
|
||||
|
||||
Section 7 -- Other Terms and Conditions.
|
||||
|
||||
a. The Licensor shall not be bound by any additional or different
|
||||
terms or conditions communicated by You unless expressly agreed.
|
||||
|
||||
b. Any arrangements, understandings, or agreements regarding the
|
||||
Licensed Material not stated herein are separate from and
|
||||
independent of the terms and conditions of this Public License.
|
||||
|
||||
|
||||
Section 8 -- Interpretation.
|
||||
|
||||
a. For the avoidance of doubt, this Public License does not, and
|
||||
shall not be interpreted to, reduce, limit, restrict, or impose
|
||||
conditions on any use of the Licensed Material that could lawfully
|
||||
be made without permission under this Public License.
|
||||
|
||||
b. To the extent possible, if any provision of this Public License is
|
||||
deemed unenforceable, it shall be automatically reformed to the
|
||||
minimum extent necessary to make it enforceable. If the provision
|
||||
cannot be reformed, it shall be severed from this Public License
|
||||
without affecting the enforceability of the remaining terms and
|
||||
conditions.
|
||||
|
||||
c. No term or condition of this Public License will be waived and no
|
||||
failure to comply consented to unless expressly agreed to by the
|
||||
Licensor.
|
||||
|
||||
d. Nothing in this Public License constitutes or may be interpreted
|
||||
as a limitation upon, or waiver of, any privileges and immunities
|
||||
that apply to the Licensor or You, including from the legal
|
||||
processes of any jurisdiction or authority.
|
||||
|
||||
=======================================================================
|
||||
|
||||
Creative Commons is not a party to its public
|
||||
licenses. Notwithstanding, Creative Commons may elect to apply one of
|
||||
its public licenses to material it publishes and in those instances
|
||||
will be considered the “Licensor.” The text of the Creative Commons
|
||||
public licenses is dedicated to the public domain under the CC0 Public
|
||||
Domain Dedication. Except for the limited purpose of indicating that
|
||||
material is shared under a Creative Commons public license or as
|
||||
otherwise permitted by the Creative Commons policies published at
|
||||
creativecommons.org/policies, Creative Commons does not authorize the
|
||||
use of the trademark "Creative Commons" or any other trademark or logo
|
||||
of Creative Commons without its prior written consent including,
|
||||
without limitation, in connection with any unauthorized modifications
|
||||
to any of its public licenses or any other arrangements,
|
||||
understandings, or agreements concerning use of licensed material. For
|
||||
the avoidance of doubt, this paragraph does not form part of the
|
||||
public licenses.
|
||||
|
||||
Creative Commons may be contacted at creativecommons.org.
|
||||
Note: Blog posts and written content (src/content/posts/) are licensed under
|
||||
Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0).
|
||||
See LICENSE-CONTENT for details.
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)
|
||||
|
||||
Copyright (c) 2024-present Avinal Kumar
|
||||
|
||||
This license applies to all blog posts and written content located in
|
||||
src/content/posts/ and any other prose content on this website.
|
||||
|
||||
You are free to:
|
||||
|
||||
Share — copy and redistribute the material in any medium or format for
|
||||
any purpose, even commercially.
|
||||
|
||||
Adapt — remix, transform, and build upon the material for any purpose,
|
||||
even commercially.
|
||||
|
||||
Under the following terms:
|
||||
|
||||
Attribution — You must give appropriate credit, provide a link to the
|
||||
license, and indicate if changes were made. You may do so in any
|
||||
reasonable manner, but not in any way that suggests the licensor
|
||||
endorses you or your use.
|
||||
|
||||
ShareAlike — If you remix, transform, or build upon the material, you
|
||||
must distribute your contributions under the same license as the
|
||||
original.
|
||||
|
||||
No additional restrictions — You may not apply legal terms or
|
||||
technological measures that legally restrict others from doing anything
|
||||
the license permits.
|
||||
|
||||
Full license text: https://creativecommons.org/licenses/by-sa/4.0/legalcode
|
||||
@@ -1,88 +1,29 @@
|
||||
PY?=python3
|
||||
PELICAN?=pelican
|
||||
PELICANTHEME?=pelican-themes
|
||||
PELICANOPTS=
|
||||
.PHONY: dev build preview clean install check fmt lint new-post help
|
||||
|
||||
BASEDIR=$(CURDIR)
|
||||
INPUTDIR=$(BASEDIR)/content
|
||||
OUTPUTDIR=$(BASEDIR)/output
|
||||
THEMEDIR=$(BASEDIR)/themes/alchemy
|
||||
CONFFILE=$(BASEDIR)/pelicanconf.py
|
||||
PUBLISHCONF=$(BASEDIR)/publishconf.py
|
||||
# Default target
|
||||
help: ## Show this help
|
||||
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | \
|
||||
awk 'BEGIN {FS = ":.*?## "}; {printf " \033[36m%-15s\033[0m %s\n", $$1, $$2}'
|
||||
|
||||
GITHUB_PAGES_BRANCH=gh-pages
|
||||
install: ## Install dependencies
|
||||
npm install
|
||||
|
||||
dev: ## Start dev server with hot reload
|
||||
npx astro dev
|
||||
|
||||
DEBUG ?= 0
|
||||
ifeq ($(DEBUG), 1)
|
||||
PELICANOPTS += -D
|
||||
endif
|
||||
build: ## Build for production
|
||||
npx astro build
|
||||
|
||||
RELATIVE ?= 0
|
||||
ifeq ($(RELATIVE), 1)
|
||||
PELICANOPTS += --relative-urls
|
||||
endif
|
||||
preview: ## Preview production build locally
|
||||
npx astro preview
|
||||
|
||||
SERVER ?= "0.0.0.0"
|
||||
check: ## Run Astro type checking
|
||||
npx astro check
|
||||
|
||||
PORT ?= 0
|
||||
ifneq ($(PORT), 0)
|
||||
PELICANOPTS += -p $(PORT)
|
||||
endif
|
||||
clean: ## Remove build artifacts
|
||||
rm -rf dist .astro node_modules/.astro
|
||||
|
||||
nuke: ## Full clean (includes node_modules)
|
||||
rm -rf dist .astro node_modules
|
||||
|
||||
help:
|
||||
@echo 'Makefile for a pelican Web site '
|
||||
@echo ' '
|
||||
@echo 'Usage: '
|
||||
@echo ' make html (re)generate the web site '
|
||||
@echo ' make clean remove the generated files '
|
||||
@echo ' make regenerate regenerate files upon modification '
|
||||
@echo ' make publish generate using production settings '
|
||||
@echo ' make theme add theme '
|
||||
@echo ' make serve [PORT=8000] serve site at http://localhost:8000'
|
||||
@echo ' make serve-global [SERVER=0.0.0.0] serve (as root) to $(SERVER):80 '
|
||||
@echo ' make devserver [PORT=8000] serve and regenerate together '
|
||||
@echo ' make ssh_upload upload the web site via SSH '
|
||||
@echo ' make rsync_upload upload the web site via rsync+ssh '
|
||||
@echo ' make github upload the web site via gh-pages '
|
||||
@echo ' '
|
||||
@echo 'Set the DEBUG variable to 1 to enable debugging, e.g. make DEBUG=1 html '
|
||||
@echo 'Set the RELATIVE variable to 1 to enable relative urls '
|
||||
@echo ' '
|
||||
|
||||
html:
|
||||
"$(PELICAN)" "$(INPUTDIR)" -o "$(OUTPUTDIR)" -s "$(CONFFILE)" $(PELICANOPTS)
|
||||
|
||||
clean:
|
||||
[ ! -d "$(OUTPUTDIR)" ] || rm -rf "$(OUTPUTDIR)"
|
||||
|
||||
regenerate:
|
||||
"$(PELICAN)" -r "$(INPUTDIR)" -o "$(OUTPUTDIR)" -s "$(CONFFILE)" $(PELICANOPTS)
|
||||
|
||||
serve:
|
||||
"$(PELICAN)" -l "$(INPUTDIR)" -o "$(OUTPUTDIR)" -s "$(CONFFILE)" $(PELICANOPTS)
|
||||
|
||||
serve-global:
|
||||
"$(PELICAN)" -l "$(INPUTDIR)" -o "$(OUTPUTDIR)" -s "$(CONFFILE)" $(PELICANOPTS) -b $(SERVER)
|
||||
|
||||
devserver:
|
||||
"$(PELICAN)" -lr "$(INPUTDIR)" -o "$(OUTPUTDIR)" -s "$(CONFFILE)" $(PELICANOPTS)
|
||||
|
||||
devserver-global:
|
||||
$(PELICAN) -lr $(INPUTDIR) -o $(OUTPUTDIR) -s $(CONFFILE) $(PELICANOPTS) -b 0.0.0.0
|
||||
|
||||
publish:
|
||||
"$(PELICAN)" "$(INPUTDIR)" -o "$(OUTPUTDIR)" -s "$(PUBLISHCONF)" $(PELICANOPTS)
|
||||
|
||||
theme:
|
||||
"$(PELICANTHEME)" --install "$(THEMEDIR)" --verbose
|
||||
|
||||
github: publish
|
||||
mkdir -p "$(OUTPUTDIR)/custom"
|
||||
cp -a custom/. "$(OUTPUTDIR)/custom/"
|
||||
cp 404.html "$(OUTPUTDIR)"
|
||||
ghp-import -m "Generate Pelican site" -b $(GITHUB_PAGES_BRANCH) "$(OUTPUTDIR)"
|
||||
git push -f origin $(GITHUB_PAGES_BRANCH)
|
||||
|
||||
.PHONY: html help clean regenerate serve serve-global devserver publish github
|
||||
fresh: nuke install ## Clean install from scratch
|
||||
|
||||
@@ -1 +1,85 @@
|
||||
# avinal.github.io
|
||||
# avinal.space
|
||||
|
||||
Personal website and blog built with [Astro](https://astro.build). Minimal, fast, and almost entirely HTML & CSS with zero-JS by default.
|
||||
|
||||
**Live:** [avinal.space](https://avinal.space)
|
||||
|
||||
## Design Inspiration
|
||||
|
||||
- [jay.fish](https://jay.fish/) — homepage layout, activity graph, bento grid
|
||||
- [usememos.com](https://usememos.com/) — clean typography, color palette, overall theme
|
||||
|
||||
## Pages
|
||||
|
||||
| Route | Description |
|
||||
|-------|-------------|
|
||||
| `/` | Homepage with hero card, GitHub/WakaTime activity graph, ListenBrainz music widget, recent posts, and pinned repos |
|
||||
| `/posts/` | Blog index with category filters and featured images |
|
||||
| `/posts/<category>/` | Category-filtered post listings |
|
||||
| `/posts/<category>/<slug>/` | Individual blog posts |
|
||||
| `/resume/` | Resume page (data driven from `src/data/resume.json`) |
|
||||
| `/events/` | Conferences and events timeline |
|
||||
| `/meeting/` | Book a meeting via [Cal.com](https://cal.com) embed |
|
||||
| `/setup/` | Hardware and software setup |
|
||||
| `/rss.xml` | RSS feed |
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- [Node.js](https://nodejs.org/) 22+
|
||||
- npm
|
||||
|
||||
## Getting Started
|
||||
|
||||
```bash
|
||||
git clone https://github.com/avinal/avinal.github.io.git
|
||||
cd avinal.github.io
|
||||
make install
|
||||
```
|
||||
|
||||
No environment variables are required. All external data is fetched from public APIs:
|
||||
|
||||
- **GitHub** — contributions graph and user info (public API)
|
||||
- **WakaTime** — coding stats via public share URL
|
||||
- **ListenBrainz** — music listening activity (public API, username in `src/config/theme.ts`)
|
||||
- **Cal.com** — meeting booking (embedded via CDN)
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
make dev # Start dev server with hot reload
|
||||
make build # Build for production
|
||||
make preview # Preview production build locally
|
||||
make check # Run Astro type checking
|
||||
make clean # Remove build artifacts
|
||||
make nuke # Full clean (includes node_modules)
|
||||
make fresh # Clean install from scratch
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
src/
|
||||
├── components/ # Reusable Astro components
|
||||
├── config/ # Theme tokens and site config
|
||||
├── content/posts/ # Blog posts (Markdown)
|
||||
├── data/ # JSON data (resume, repos, events)
|
||||
├── layouts/ # Page layouts
|
||||
├── lib/ # Utilities and rehype plugins
|
||||
├── pages/ # Route pages
|
||||
└── styles/ # Global CSS
|
||||
public/ # Static assets (images, favicons)
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
- **Theme & colors:** `src/config/theme.ts` — single file for all design tokens, easily swap the entire color palette
|
||||
- **Repos:** `src/data/repos.json` — pinned repositories shown on the homepage
|
||||
- **Resume:** `src/data/resume.json` — JSON Resume format, drives the `/resume/` page
|
||||
|
||||
## Deployment
|
||||
|
||||
The site is deployed via [Netlify](https://netlify.com). Any push to `main` triggers a build automatically. See `netlify.toml` for the build config.
|
||||
|
||||
## License
|
||||
|
||||
See [LICENSE](LICENSE) for details.
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
import { defineConfig } from "astro/config";
|
||||
import sitemap from "@astrojs/sitemap";
|
||||
import rehypeImageAlign from "./src/lib/rehype-image-align.ts";
|
||||
import rehypeSlug from "rehype-slug";
|
||||
import rehypeAutolinkHeadings from "rehype-autolink-headings";
|
||||
|
||||
export default defineConfig({
|
||||
site: "https://avinal.space",
|
||||
output: "static",
|
||||
integrations: [sitemap()],
|
||||
prefetch: true,
|
||||
markdown: {
|
||||
shikiConfig: {
|
||||
theme: "github-dark-default",
|
||||
},
|
||||
rehypePlugins: [
|
||||
rehypeImageAlign,
|
||||
rehypeSlug,
|
||||
[
|
||||
rehypeAutolinkHeadings,
|
||||
{
|
||||
behavior: "append",
|
||||
properties: { className: ["heading-anchor"], ariaLabel: "Link to this section" },
|
||||
content: { type: "text", value: "#" },
|
||||
},
|
||||
],
|
||||
],
|
||||
},
|
||||
});
|
||||
@@ -1,31 +0,0 @@
|
||||
****************
|
||||
The Big Red Ants
|
||||
****************
|
||||
|
||||
:date: 2012-02-27 22:47
|
||||
:tags: ants, sav
|
||||
:category: article
|
||||
:slug: red-big-ants
|
||||
:summary: In a bird’s eye view if we see around us, ants are the common and tiniest living entitiy seen by naked eye. One of them are the big red ants, in my view they are unique from others in two ways, first they live on trees and second their anteenas are too long and bent in middle, seems like their fore legs. Their mandible (mouth) seems like eagle’s beak.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<p style="border: 2px solid var(--cyan);border-radius: 7px;" align=center>This article was published in 3rd edition of नवांकुर , the official magazine of Simultala Awasiya Vidyalaya, Bihar, India.<p>
|
||||
|
||||
In a bird’s eye view if we see around us, ants are the common and tiniest living entitiy seen by naked eye. One of them are the big red ants, in my view they are unique from others in two ways, first they live on trees and second their anteenas are too long and bent in middle, seems like their fore legs. Their mandible (mouth) seems like eagle’s beak.
|
||||
|
||||
|
||||
|
||||
As I observed them making and reparing their nests, I concluded that they are very laborious and intellectual. They create their nests by binding two or more leaves (maybe up to 500) together. They stich the leaves using a stinky white substance either excreted by themselves or from trees. This substance is like web of spider. At first builder ants creates an array at the blade of two leaves. Then they make ant-cranes or ant-chain like chain of monomer to form a polymer. They catch the leaves and pull each other to stich. After some time, the parliament of leaves transforms into a leaf-sac called their nest. They also weave translucent cloth like structure to cover remainings of leaf. A nest hangs by a branch of the trees.
|
||||
|
||||
|
||||
|
||||
A nest is skillfully divided into living rooms, barracks, storehouse, egg room and queen’s room. The eggroom, lies at the center of nest to protect from outer attack until last time. Besides that, lies queen’s room. Living rooms are sequenncly joined with eggroom. There are different rooms for workers, food searchers etc. The partition of the room resembles atom’s electron shell, one upon another. At last barracks are the outermost rooms, just like outermost orbit of electron. The defence system is strongest at the nest’s opening. A nest may size as 2-3 footballs and have 50 to 10000 ants. There may be more openings.
|
||||
|
||||
|
||||
|
||||
Now about their attacking and protecting skills. A solider is unique from other ants. It is equipped with many attacking and defending skills. Normally they do not attack. They are social insects. If someone attacks, all other ants go inside, and soldiers come out. They spread allover the nest. They are very sensetive and have sharp vision. If any one of them see their enemy the stand on their hind legs, swinging, their forelegs and anteens in their air as scolding someone. Their spit contains formic acid, present at the end of the abdomen below the rectum. If their nest is broken and eggs fall on ground then the ants make a dome, like the dome of Taj mahal to save the eggs till last their breadth. This shows their caring skills.
|
||||
|
||||
|
||||
|
||||
The most amazing is their discipline. They can easily beat a human in race of discipline. Humans must learn from it. When two ants meet, they touch their anteena to communicate. When they walk in a queue, they seem like twinkling dots and dashes. I want to conclude that **All tiny things are not really tiny. It may be as a space having infinite mysteries one has to explore it.**
|
||||
@@ -1,45 +0,0 @@
|
||||
*************************
|
||||
The Interstellar Twilight
|
||||
*************************
|
||||
|
||||
:date: 2020-09-28 22:47
|
||||
:tags: interstellar, twilight
|
||||
:category: blog
|
||||
:slug: this-is-for-you
|
||||
:summary: If in the Twilight of dreams we should meet once more, we shell talk again together and I shall sing to you a lullaby till you sleep again to meet me in the Twilight of another dream.
|
||||
|
||||
|
||||
Yeah, it was a dream someday. I never imagined you. But I do remember glimpses of a wonderful person
|
||||
in my deep slumber. When I go back to last year about the same time, I find myself a manic who gets
|
||||
carried away with every emotion. Becoming too happy about something and then becoming too sad was so
|
||||
common that I never noticed what I was risking.
|
||||
|
||||
**"If in the Twilight of dreams we should meet once more, we shell talk again together and I shall sing to you a lullaby till you sleep again to meet me in the Twilight of another dream."**
|
||||
|
||||
|
||||
But 1 year ago many things changed. A never seen dream came true. To be honest I was skeptical if all
|
||||
this happening to me was true. Even until last December. Gradually things started falling into places.
|
||||
And for the most part, the reality became more real. I can now easily see what is happening and why it
|
||||
happened. Everything was so nice until we had a fight. Then another, and now it was every other day
|
||||
story. It was a really hard time collecting everything together and act as nothing happened after every
|
||||
single of those. Everything was plunging. I started imagining the end of something that I did not
|
||||
imagine to happen in the first place.
|
||||
|
||||
But during all those times, there was a continual intuition that maybe there is something that we both
|
||||
are missing. And that was maybe the root of all chaos. I never came to know that what it was neither did
|
||||
you. But I do realize many mistakes I have been doing since we met.
|
||||
|
||||
I want to thank you for not losing hope in me. We both always tried to reduce tension as much as we could.
|
||||
And thank you for many other ineffable things happened because of you.
|
||||
|
||||
As of now I can see things making sense. Every message, every talk now seems to make sense. I am more
|
||||
deeply into this friendship if I was not ever before. The ecstasy of having you is other-worldly. I don't
|
||||
know if I could ever adore a person this much but I adore this ravishing friendship. Only you or only
|
||||
this friendship may mean nothing to me. But I am delighted to say that I have both and I have you.
|
||||
|
||||
Now, what is all with The Interstellar Twilight. Why this name ? Let me explain it for you. **Interstellar**
|
||||
means between stars and **Twilight** means the soft glow when the sun is below the horizon.
|
||||
**The Interstellar Twilight** means the glow between the stars or simply glow of a cluster of stars. A
|
||||
single star shines but the glow is too low to be noticed against its brightness. But a lot stars together
|
||||
gets a glow. So my friend we are such two stars and our friendship is that glow.
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
************
|
||||
My Checklist
|
||||
************
|
||||
|
||||
:date: 2021-02-14 22:47
|
||||
:slug: checklist
|
||||
:category: development
|
||||
:tags: rst, github
|
||||
:status: draft
|
||||
@@ -1,432 +0,0 @@
|
||||
**************************
|
||||
Google Summer of Code 2021
|
||||
**************************
|
||||
|
||||
:date: 2021-08-19 23:07
|
||||
:tags: gsoc, FOSSology
|
||||
:category: report
|
||||
:summary: This is the final report of my Google Summer of Code 2021 at The FOSSology Project.
|
||||
:slug: final-evaluation
|
||||
:status: published
|
||||
|
||||
.. role:: rd
|
||||
|
||||
.. role:: gr
|
||||
|
||||
.. role:: or
|
||||
|
||||
.. role:: html-raw(raw)
|
||||
:format: html
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<style>
|
||||
.rd {color:red;font-weight:bold}
|
||||
.gr{color:green;font-weight:bold}
|
||||
.or{color:orange;font-weight:medium}
|
||||
ul{margin-bottom:0}
|
||||
</style>
|
||||
|
||||
The CMake Build system
|
||||
----------------------
|
||||
|
||||
FOSSology is quite an old and mature project. The project has been using bare metal **Makefiles**. As the project is growing with new agents and modernization it was required to have a modern build system.
|
||||
|
||||
The FOSSology is a suite of well-integrated and synchronized sub-projects (called agents) written in C, C++, and PHP. Most of the major agents are in C, C++ and that made CMake an obvious choice for a new build system for FOSSology. CMake is a versatile set of build, test, and packaging tools and is the most popular choice of C/C++ developers. CMake can be extended to create a build system for other languages too via custom scripts.
|
||||
|
||||
|
||||
GitHub Actions CI/CD
|
||||
--------------------
|
||||
|
||||
.. image:: /images/ci.png
|
||||
:class: float-md-right rounded border border-info ml-3
|
||||
:alt: A CI Meme
|
||||
:width: 350
|
||||
|
||||
Since the FOSSology project moved on Github, it has used only the free Travis CI service for OSS projects.
|
||||
At the time of writing Travis CI has reduced its free tier CI services. GitHub Actions provides faster builds. Since GitHub Actions is a fully managed service by GitHub, we don’t need to know how to scale and operate the infrastructure to run it.
|
||||
|
||||
It is straightforward to use with GitHub because when we fork a repository, the actions automatically get forked. This allows you to test and build projects very efficiently and even run them closer to the developer. Also, you have readily available access to the GitHub API, making it more popular among developers.
|
||||
|
||||
Improvements over previous build system and CI
|
||||
----------------------------------------------
|
||||
|
||||
The new build system and CI brings a lot of improvements and features. The list below describes them.
|
||||
|
||||
- CMake enforces out-of-source builds. This was already possible with the previous build system but not a strict requirement. This feature keeps the source code clean and makes cleaning the build artifacts easy. (Just remove the build folder :)
|
||||
- One of the major improvements over the previous build system is faster build times. CMake generates parallel build-enabled configurations for all generators. In our tests, the new build system is at least twice as fast as the previous one. With further improvement in configuration, we will be able to further cut the build times.
|
||||
- Previously FOSSology can only be built using *Unix Makefiles*. With CMake, we can now use many other popular generators such as *Ninja*.
|
||||
- Now it is also very flexible to choose different compilers. This will help support more platforms and architecture in the future. As of now, we are experimenting with Clang compilers.
|
||||
- FOSSology is quite an old project and a lot of agent testing code was written in the last decade. Initially, none of them were compatible with the new build system, but we were able to hack most of the test code using better-improved methods. Test times have also improved.
|
||||
- Migrating from Travis CI to GitHub Actions was another big move and for the most part, it removes the dependency on a third-party CI service. Along with that GitHub Actions provides better build times, tons of new features, and better integration with other GitHub services.
|
||||
|
||||
|
||||
|
||||
|
||||
Deliverables
|
||||
--------------
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="alert alert-info" role="alert">
|
||||
<ul class="simple">
|
||||
<li>Final Pull Request <a class="badge badge-info" href="https://github.com/fossology/fossology/pull/2075">#2075</a></li>
|
||||
<li>Pull Request Branch <a class="badge badge-info" href="https://github.com/avinal/fossology/tree/avinal/feat/buildsystem">avinal/feat/buildsystem</a></li>
|
||||
<li>Working Branch (individual commits) <ul>
|
||||
<li><a class="badge badge-info" href="https://github.com/avinal/fossology/tree/avinal/feat/cmake-buildsystem">avinal/feat/cmake-buildsystem</a></li>
|
||||
<li><a class="badge badge-info" href="https://github.com/avinal/fossology/tree/avinal/feat/testing">avinal/feat/testing</a></li>
|
||||
</ul></li>
|
||||
<li>Project Issue <a class="badge badge-info" href="https://github.com/fossology/fossology/issues/1913">#1913</a></li>
|
||||
<li>Project Discussion <a class="badge badge-info" href="https://github.com/fossology/fossology/discussions/1931">#1931</a></li>
|
||||
<li>Weekly Reports<ul>
|
||||
<li><a class="badge badge-info" href="https://gsoc.avinal.space">Personal Blog</a></li>
|
||||
<li><a class="badge badge-info" href="https://fossology.github.io/gsoc/docs/2021/buildsystem/">FOSSology Official Blog</a></li>
|
||||
</ul></li></ul>
|
||||
</div>
|
||||
|
||||
|
||||
**CMake Build System Tasks**
|
||||
|
||||
.. table::
|
||||
:class: table table-sm table-hover table-bordered table-responsive
|
||||
:widths: 5 15 10 10 20 15 25
|
||||
:align: center
|
||||
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| # | Agents | Build | Install | Testing | Packaging | Remarks |
|
||||
+====+==================+===========+===========+====================+===========+================+
|
||||
| 1 | adj2nest | :gr:`YES` | :gr:`YES` | | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 2 | buckets | :gr:`YES` | :gr:`YES` | | :gr:`YES`| |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 3 | cli | :gr:`YES` | :gr:`YES` | - :rd:`Functional` | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 4 | copyright | :gr:`YES` | :gr:`YES` | - :gr:`Functional` | | |
|
||||
| | | | | - :gr:`Unit` | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 5 | debug | | :gr:`YES` | | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 6 | decider | :gr:`YES` | :gr:`YES` | - :gr:`Functional` | | |
|
||||
| | | | | - :gr:`Unit` | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 7 | deciderjob | :gr:`YES` | :gr:`YES` | - :gr:`Functional` | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 8 | delagent | :gr:`YES` | :gr:`YES` | - :rd:`Functional` | | |
|
||||
| | | | | - :rd:`Unit` | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 9 | demomod | :or:`YES` | :or:`YES` | - :or:`Functional` | :or:`NO` | *(Not Used)* |
|
||||
| | | | | - :or:`Unit` | | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 10 | example_wc_agent | :or:`YES` | :or:`YES` | - :or:`Functional` | :or:`NO` | *(Not Used)* |
|
||||
| | | | | - :or:`Unit` | | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 11 | clib | :gr:`YES` | :gr:`YES` | - :gr:`Functional` | | |
|
||||
| | | | | - :gr:`Unit` | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 12 | cpplib | :gr:`YES` | :gr:`YES` | - :gr:`Unit` | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 13 | phplib | :gr:`YES` | :gr:`YES` | - :gr:`Functional` | | 1 functional |
|
||||
| | | | | - :gr:`Unit` | :gr:`YES` | test needs fix |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 14 | maintagent | :gr:`YES` | :gr:`YES` | | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 15 | mimetype | :gr:`YES` | :gr:`YES` | - :gr:`Functional` | | |
|
||||
| | | | | - :gr:`Unit` | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 16 | monk | :gr:`YES` | :gr:`YES` | - :gr:`Functional` | | |
|
||||
| | | | | - :gr:`Unit` | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 17 | ninka | :or:`YES` | :or:`YES` | - :or:`Functional` | :or:`NO` | *(Deprecated)* |
|
||||
| | | | | - :or:`Unit` | | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 18 | nomos | :gr:`YES` | :gr:`YES` | - :gr:`Functional` | | |
|
||||
| | | | | - :gr:`Unit` | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 19 | ojo | :gr:`YES` | :gr:`YES` | - :gr:`Functional` | | 1 functional |
|
||||
| | | | | - :gr:`Unit` | :gr:`YES` | test needs fix |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 20 | pkgagent | :gr:`YES` | :gr:`YES` | - :gr:`Functional` | | |
|
||||
| | | | | - :gr:`Unit` | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 21 | readmeoss | :gr:`YES` | :gr:`YES` | | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 22 | regexscan | :or:`YES` | :or:`YES` | | :or:`NO` | *(Deprecated)* |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 23 | reportImport | :gr:`YES` | :gr:`YES` | | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 24 | reuser | :gr:`YES` | :gr:`YES` | - :gr:`Functional` | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 25 | reso | :gr:`YES` | :gr:`YES` | | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 26 | scheduler | :gr:`YES` | :gr:`YES` | - :rd:`Functional` | | Tests needs |
|
||||
| | | | | - :rd:`Unit` | :gr:`YES` | fix |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 27 | softwareHeritage | :gr:`YES` | :gr:`YES` | | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 28 | spasht | :gr:`YES` | :gr:`YES` | | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 29 | spdx2 | :gr:`YES` | :gr:`YES` | - :gr:`Functional` | | 1 Test failing |
|
||||
| | | | | - :gr:`Unit` | :gr:`YES` | in CI |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 30 | unifiedreport | :gr:`YES` | :gr:`YES` | - :gr:`Functional` | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 31 | ununpack | :gr:`YES` | :gr:`YES` | - :gr:`Functional` | | Unit tests |
|
||||
| | | | | - :rd:`Unit` | :gr:`YES` | needs fix |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 32 | wget_agent | :gr:`YES` | :gr:`YES` | - :gr:`Functional` | | |
|
||||
| | | | | - :gr:`Unit` | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
| 32 | www | :gr:`YES` | :gr:`YES` | - :rd:`UI` | :gr:`YES` | |
|
||||
+----+------------------+-----------+-----------+--------------------+-----------+----------------+
|
||||
|
||||
|
||||
**GitHub Actions CI Tasks**
|
||||
|
||||
.. table::
|
||||
:class: table table-sm table-hover table-bordered table-responsive
|
||||
:widths: 5 25 70
|
||||
:align: center
|
||||
|
||||
+---+------------------------+----------------------------------------------------------+
|
||||
| # | CI Tasks | Status |
|
||||
+===+========================+==========================================================+
|
||||
| 1 | :gr:`build` | Added Ubuntu 20.04 GCC 8, 9 and Clang, GCC 7 not working |
|
||||
+---+------------------------+----------------------------------------------------------+
|
||||
| 2 | :gr:`c/cpp unit test` | Added, delagent, scheduler and ununpack not working |
|
||||
+---+------------------------+----------------------------------------------------------+
|
||||
| 3 | :gr:`phpunit tests` | Added, delagent and scheduler functional not working |
|
||||
+---+------------------------+----------------------------------------------------------+
|
||||
| 4 | :rd:`cahching` | Not implemented |
|
||||
+---+------------------------+----------------------------------------------------------+
|
||||
| 5 |:rd:`source install` | Not implemented |
|
||||
+---+------------------------+----------------------------------------------------------+
|
||||
|
||||
(:gr:`GREEN`: COMPLETED, :rd:`RED`: INCOMPLETE, :or:`ORANGE`: NOT NEEDED/DEPRECATED)
|
||||
|
||||
|
||||
|
||||
How does it work and how to use it?
|
||||
-----------------------------------
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="embed-responsive embed-responsive-16by9">
|
||||
<iframe class="embed-responsive-item" src="/images/second-build.webm" allowfullscreen></iframe>
|
||||
</div>
|
||||
|
||||
The new build system retains the modular and hierarchical structure of the previous build system. On the other hand, the new build system provides several new flags to control the build. The new build system forces out-of-source build instead of the previous in-source builds. This keeps the source clutter-free and reduces the chance of accidentally deleting source files. *Testing still needs some in-source artifacts, this will be solved once all the tests are fixed according to the new build system.*
|
||||
|
||||
Each agent is a complete CMake sub-project with its independent configuration for building, installing, and testing. That means a single agent can be built and installed separately and even removed from the default build without breaking other builds. The directory structure is as below.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
.
|
||||
├── build # temporary directory for build artifacts
|
||||
├── cmake # CMake modules for FOSSology
|
||||
│ ├── FoPackaging.cmake # CMake Packaging configurations
|
||||
│ ├── FoUtilities.cmake # Custom CMake utilities
|
||||
│ ├── FoVersionFile.cmake # VERSION version.php CMake template file
|
||||
│ ├── SetDefaults.cmake # CMake defaults for this project
|
||||
│ ├── TestInstall.make.in # Template makefile for install during tests
|
||||
│ └── VERSION.in # VERSION file template
|
||||
├── src
|
||||
│ ├── agent-1 # Agent sub-project
|
||||
│ │ ├── agent # Agent's source code directory
|
||||
│ │ │ ├── agent-source-code
|
||||
│ │ │ └── CMakeLists.txt
|
||||
│ │ ├── agent_tests # Agent's test directory
|
||||
│ │ │ ├── Unit
|
||||
│ │ │ ├── Functional
|
||||
│ │ │ └── CMakeLists.txt
|
||||
│ │ ├── ui # Agent's UI source code
|
||||
│ │ │ ├── templates
|
||||
│ │ │ └── agent-ui-code
|
||||
│ │ └── CMakeLists.txt # Agent's top-level CMake configuration
|
||||
: :
|
||||
│ ├── other agents
|
||||
: :
|
||||
│ └── CMakeLists.txt # Source intermediate CMake configuration
|
||||
:
|
||||
├── other directories and files
|
||||
:
|
||||
└── CMakeLists.txt # FOSSology Top-level CMake configuration
|
||||
|
||||
|
||||
The :code:`cmake` directory contains customized CMake modules and templates for FOSSology. This directory is required for all the operations. The general workflow of the new build system as well as how to use it is described below.
|
||||
|
||||
1. Since the new build system is still in review. You must fork FOSSology and pull the `#2075 <https://github.com/fossology/fossology/pull/2075>`_ pull request branch. Once you are in FOSSology root, run these commands.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git fetch https://github.com/avinal/fossology avinal/feat/buildsystem:buildsystem
|
||||
git checkout buildsystem
|
||||
|
||||
|
||||
2. The first step towards building is to create a temporary directory for storing intermediate files and build artifacts. By convention we use a directory named :code:`build`, but you can use any name. (**NOTE: For testing do not use other names**)
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
mkdir build
|
||||
cd build
|
||||
|
||||
|
||||
3. In the next steps, we will configure the CMake project and generate the required configurations. You can use several flags to control the build. Given below are the flags available for this project.
|
||||
|
||||
.. table::
|
||||
:class: table table-sm table-hover table-bordered table-responsive
|
||||
|
||||
+-----------------------------------+--------------------------------------------+--------------------+
|
||||
| CMake Flags | Description | Default |
|
||||
+===================================+============================================+====================+
|
||||
| **-DCMAKE_INSTALL_PREFIX=<path>** | Sets the install prefix. | :code:`/usr/local` |
|
||||
+-----------------------------------+--------------------------------------------+--------------------+
|
||||
| **-DAGENTS="agent1;agent2..."** | Only configure these agents. | ALL AGENTS |
|
||||
+-----------------------------------+--------------------------------------------+--------------------+
|
||||
| **-DOFFLINE=<ON/OFF>** | Controls vendor generation, ON=NO | **OFF** |
|
||||
+-----------------------------------+--------------------------------------------+--------------------+
|
||||
| **-DCMAKE_BUILD_TYPE=<type>** | - :code:`Debug` | |
|
||||
| | - :code:`Release` | :code:`Debug` |
|
||||
| - Controls build type aka | - :code:`RelWithDebInfo` | |
|
||||
| level optimisation | - :code:`MinSizeRel` | |
|
||||
+-----------------------------------+--------------------------------------------+--------------------+
|
||||
| **-DTESTING=<ON/OFF>** | Controls testing config generation | **OFF** |
|
||||
+-----------------------------------+--------------------------------------------+--------------------+
|
||||
| **-DMONOPACK=<ON/OFF>** | Package adj2nest and ununpack seperately | **OFF** |
|
||||
+-----------------------------------+--------------------------------------------+--------------------+
|
||||
| **-GNinja** | Use Ninja instead of Unix Makefiles | *Unix MakeFiles* |
|
||||
+-----------------------------------+--------------------------------------------+--------------------+
|
||||
|
||||
There are lots of inbuilt CMake command-line options you can see them in the official `documentation <https://cmake.org/cmake/help/v3.10/manual/cmake.1.html>`_. Once you have chosen your flags we can now configure the project using the following commands.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# From build folder
|
||||
cd <name-of-build-directory>
|
||||
cmake <flags> ..
|
||||
|
||||
|
||||
4. The next step is to build the project. You can use parallel jobs to build faster. For more options you can type :code:`cmake --help` or :code:`make --help` or :code:`ninja --help`.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# Common build command for all generators,
|
||||
# Default number of parallel builds depends on generator used
|
||||
cmake --build . --parallel <no-of-processes>
|
||||
|
||||
# For Unix Makefiles, no parallel build by default
|
||||
make -j <no-of-processes>
|
||||
|
||||
# For Ninja, 8+ parallel build by default (depends on system)
|
||||
ninja -j <no-of-processes>
|
||||
|
||||
|
||||
5. Installing is also as easy as building. You can choose to install only certain components even if you have built the whole project. If you directly invoke the install command without building the project, it will automatically build the project first.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# For Unix Makefiles
|
||||
make install
|
||||
|
||||
# For Ninja
|
||||
ninja install
|
||||
|
||||
|
||||
6. While testing has some issues, most of the testing is working fine. For now, you must build and run any test from the FOSSology root directory only. You can choose to configure a single agent if you want to test one agent only. See :code:`ctest --help` for controlling test runs.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# Common testing command
|
||||
ctest --parallel <no-of-processes>
|
||||
|
||||
# For Unix Makefiles
|
||||
make test
|
||||
|
||||
# For Ninja
|
||||
ninja test
|
||||
|
||||
|
||||
7. You can package FOSSology, the packaging currently lacks copyright and conf files. But for testing purposes, you can use the following commands. Similar to installing, if you run the package command without building the project, it will automatically build the project first. See :code:`cpack --help` for more packaging options.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# Common testing command
|
||||
cpack
|
||||
|
||||
# For Unix Makefiles
|
||||
make package
|
||||
|
||||
# For Ninja
|
||||
ninja package
|
||||
|
||||
|
||||
Known Issues and Drawbacks
|
||||
--------------------------
|
||||
|
||||
Although the transition from Makefiles to CMake and Travis CI to GitHub Actions is almost complete and working as expected. But it is not free of drawbacks and issues. This section outlines the known issues at the time of writing.
|
||||
|
||||
.. image:: https://imgs.xkcd.com/comics/conference_question.png
|
||||
:class: float-md-right rounded border border-info ml-3
|
||||
:alt: A Bug Meme
|
||||
:width: 350
|
||||
|
||||
|
||||
- Coverage builds may fail with linking errors.
|
||||
- Packaging prefix is the same as the install prefix. This requires the developer to set the install prefix manually before packaging to produce packages with the correct directory structure.
|
||||
- Testing and packaging must be used from the FOSSology root directory. Not doing so may or may not configure the project as intended.
|
||||
- Previously tests were written hardcoded for the Makefiles. But new build system requires all artifacts to be generated in a separate directory. This required me to add symbolic links wherever a generated script or file is expected. Tests can still leave some artifacts inside source folders.
|
||||
- There is no easy way to install a particular agent from the FOSSology root directory.
|
||||
- Packages don't contain copyright, readme, and license files. CMake doesn't provide a way to include these files. This is being tracked by issue `#21832 <https://gitlab.kitware.com/cmake/cmake/-/issues/21832>`_.
|
||||
- While packaging the symbolic links may or may not be dereferenced and hence results in copying the folder too in the target directory.
|
||||
- Running tests locally may require switching to :code:`fossy` user.
|
||||
- While configured for testing, it may give permission errors.
|
||||
- Scheduler, Ununpack, and Delagent unit and functional tests are not working. I have added an issue `#2084 <https://github.com/fossology/fossology/issues/2084>`_ to track the progress on fixing these tests.
|
||||
- CMake doesn't generate uninstall targets. The closest thing to uninstall is `this snippet <https://gitlab.kitware.com/cmake/community/-/wikis/FAQ#can-i-do-make-uninstall-with-cmake>`_. This will be later added to the FOSSology.
|
||||
|
||||
|
||||
Challenges Faced
|
||||
----------------
|
||||
|
||||
While this whole project was challenging, some aspects of it were unforeseen and more challenging. When I decided to go on with this project I just had enough CMake knowledge to write a configuration for a very small project. I had never used CMake on this big scale. On the other side, the FOSSology community is largely unknown to CMake so for all of us it was learned, practiced, and implement. With support from mentors, I was able to overcome this challenge with flying colors.
|
||||
|
||||
The other challenge was to understand the old build system, how they are all connected and what is the flow. The complexity can be imagined by the fact that the most of code and configurations were written in the decade before the last decade and haven't changed much since then.
|
||||
|
||||
The most challenging task was to make tests work with the new build system. Since tests were mostly hardcoded and the new build system refactored many of the files and directory, the tests were failing initially. The testing part took me the most time. All thanks to my mentor Gaurav and my friend Sarita I was able to hack them to suit the new build system.
|
||||
|
||||
Related Resources and Links
|
||||
---------------------------
|
||||
|
||||
- Fix FOSSology agent tests issue `#2084 <https://github.com/fossology/fossology/issues/2084>`_
|
||||
- feat(CI): Migrate API docs generation and deployment to GitHub Actions pull request `#1917 <https://github.com/fossology/fossology/pull/1917>`_
|
||||
- feat(CI): Migrate Static Checks and Analysis to GitHub Actions from Travis CI `#1919 <https://github.com/fossology/fossology/pull/1919>`_
|
||||
|
||||
|
||||
Future Development Plans
|
||||
------------------------
|
||||
|
||||
There is a lot to do with the new build system and CI and it will probably take a year or to reach a maturity point. I was able to meet most of the goals but some of them are remaining.
|
||||
|
||||
- Fix the tests, probably renovate them from the ground up.
|
||||
- Find a hack for packaging problems.
|
||||
- Improve and optimize the build.
|
||||
- Modernise the source code, remove old, bloated code and replace them according to new standards.
|
||||
|
||||
|
||||
What did I learn from this project?
|
||||
-----------------------------------
|
||||
|
||||
This Google Summer of Code was the busiest time of my life for all good reasons. I learned a lot about license compliance and how it all works in the software industry. The next big thing is CMake. As I mentioned I was just a novice user of CMake. Now I am confident that given any other large project I will be able to migrate it/improve it. I got to learn PHP, of which I did not know a single word before GSoC. And finally, I learned about packing and testing. I had these courses but implementing them myself and fixing them was a wholesome experience.
|
||||
|
||||
Other than that I improved on my communication and presentation skills. Collaborating with fellow participants was one of the great things that happened during GSoC.
|
||||
|
||||
|
||||
Acknowledgments
|
||||
---------------
|
||||
|
||||
Google Summer of Code is the best thing that has happened to me this year so far. Although there are numerous people to say thanks to, I want to mention key people who were my motivation and support during this period.
|
||||
|
||||
First of all, I want to thank and appreciate my mentors `Gaurav Mishra <https://github.com/GMishx>`_, `Michael C. Jaeger <https://github.com/mcjaeger>`_, `Anupam Ghosh <https://github.com/ag4ums>`_, and `Shaheem Azmal M MD <https://github.com/shaheemazmalmmd>`_. Without the help and support from them, all this would not have been possible. They are very polite, knowledgeable, and helpful.
|
||||
|
||||
I want to thank my friend and :abbr:`fellow participant (Integrating ScanCode Toolkit to FOSSology)` `Sarita <https://github.com/itssingh>`_. Thank you for being a collaborator, support, and motivation for attempting GSoC.
|
||||
|
||||
Finally, I want to thank, my family and friends. I got to meet many awesome developers as my fellow participants from around the world, I wish we will do more collaboration in the future.
|
||||
|
||||
@@ -1,64 +0,0 @@
|
||||
**************************************************************************
|
||||
:abbr:`HRT (Hudson River Trading)` Systems Internship Interview Experience
|
||||
**************************************************************************
|
||||
|
||||
:date: 2021-01-04 21:47
|
||||
:tags: HRT, hudsonrivertrading, interview, internship
|
||||
:slug: hrt-interview-1
|
||||
:category: blog
|
||||
:summary: I applied for **Systems Internship - Summer 2021** back in December 2020 at `Hudson River Trading <https://www.hudsonrivertrading.com>`_ , New York.....Questions were clear and of medium level. But they were designed in such a way that you must know the basics before you could attempt.
|
||||
|
||||
I applied for **Systems Internship - Summer 2021** back in December 2020 at `Hudson River Trading <https://www.hudsonrivertrading.com>`_ , New York. The internship description was: -
|
||||
|
||||
.. epigraph::
|
||||
|
||||
We are looking for highly motivated students who are eager to learn and excited about systems to join us for our summer internship
|
||||
program. As a systems intern, you may have the opportunity to work on projects in the following areas:
|
||||
|
||||
* Programming/scripting (Golang, Python, C++, C)
|
||||
* FOSS development
|
||||
* HPC, Cluster computing
|
||||
* System Administration
|
||||
* Linux, Debian
|
||||
* Linux-based computer security
|
||||
* Data Storage
|
||||
* Large deployment or config management
|
||||
|
||||
The first step was a coding test on the Codility platform. If you have used any of the online coding platforms, this is similar. It was a :abbr:`2.5 hrs (90 mins)` test consisting of 3 questions. They let you use :abbr:`online references (documentation, man pages, etc.)` but
|
||||
**do not copy the code** as it will highly reduce your chances of qualifying for this first stage. You can choose between **C/C++**,
|
||||
**Python** and **Golang** (no Java 😪).
|
||||
|
||||
Questions were clear and of medium level. But they were designed in such a way that you must know the basics before you could attempt.
|
||||
Also, they expected a clear and concise approach. Two of the most important points in their instructions were: -
|
||||
|
||||
.. epigraph::
|
||||
|
||||
* While correctness and performance are the most important factors for evaluation, we will take test duration into account as well.
|
||||
* Please understand that this test is meant to be challenging. A perfect score is not necessary to move on to future interview rounds, so do the best you can!
|
||||
|
||||
|
||||
So, you must be near perfect in your approach as well as on time. I did them kind of quickly. They will show you a summary of your
|
||||
submission but not the results. It will take almost 2 weeks to get back to you for further steps.
|
||||
|
||||
Next, I received a mail invitation for a telephonic interview. **This interview will last about 45 minutes and will be technical but will not require coding. Interview topics may include your background, programming languages, and Unix/Linux concepts**. Once you receive this
|
||||
mail you can then decide a time slot for an interview.
|
||||
|
||||
I was not sure what they will ask if this is not a coding interview. The interviewer was very polite, and he was explaining the questions
|
||||
too. Questions were not so tricky but practical and real-life. Since it was **not for SDE role**, the questions were mostly related to
|
||||
Linux/Unix, C++ (mainly pointers and memory), Python/Bash scripting, automation, knowledge of tools (IDEs, Editors, System Administration
|
||||
Tools) and previous experiences. The interview would often explain why he is asking this question, this was very nice. Then some common
|
||||
interview questions, why do you want to work for this role? What makes you fit for this role? etc.
|
||||
|
||||
One thing that I want to point out is that the interviewer was repeatedly checking my resume, and for the most part he did not ask
|
||||
anything that was not on my resume. So, my tip is to create a nice resume with genuine work/tool experiences. And when you are applying
|
||||
for such a role, it would be helpful if you mention mathematics or other courses that you have taken. *Do not lie on your resume*. They
|
||||
will easily catch that.
|
||||
|
||||
The other thing is to keep your words short and clear; I was not great at communication, but you can be. If the interviewer allows then
|
||||
use examples for the things you cannot explain. I used nice examples. At last, he gave me short feedback on how well I performed.
|
||||
|
||||
At last, I want to point out things I should not have done. The first is, I did not ask much about the role, you must do this at least
|
||||
once. Second, I am talkative, I do not know if the interviewer was not faking his expressions (because he would often discuss in-depth),
|
||||
but not all interviewers will be the same. So, do not talk too much, nor too less. At last work on your communication skill, mostly how
|
||||
you to present things and how to answer technical as well as behavioral questions. I was not fluent, but my way of presentation might
|
||||
have saved me.
|
||||
@@ -1,12 +0,0 @@
|
||||
|
||||
************************************
|
||||
Google Summer of Code 2021 Selection
|
||||
************************************
|
||||
|
||||
:date: 2021-05-17 23:22
|
||||
:slug: finally-gsoc
|
||||
:category: gsoc
|
||||
:tags: gsoc, gsoc21, fossology
|
||||
:status: draft
|
||||
|
||||
Finally after three years I have been selected in **Google Summer of Code** program at **The FOSSology Project**. I will be working on *New Buildsystem and CI/CD* for the project.
|
||||
@@ -1,239 +0,0 @@
|
||||
**************************************************************
|
||||
Create the VLC User Documentation for one Mobile Port(Android)
|
||||
**************************************************************
|
||||
|
||||
:date: 2020-12-01 23:47
|
||||
:modified: 2020-12-31 23:19
|
||||
:slug: vlc-gsod-report
|
||||
:category: development
|
||||
:tags: vlc, gsod, gsod2020
|
||||
:summary: The project was to Create the VLC User Documentation for Android Mobile Port which was previously hosted on VLC’s wiki pages. The major portion of this was to start everything from scratch including chapter separation, section organization.
|
||||
|
||||
OVERVIEW
|
||||
--------
|
||||
|
||||
VideoLAN is a non-profit organization that develops software for playing video and other media formats. VLC media player (commonly known as just VLC) is a free and Open Source cross-platform multimedia player and framework that plays most multimedia files as well as DVDs, Audio CDs, VCDs, and various streaming protocols built by the VideoLAN organization and a team of volunteers. VLC for Android is a port of the VLC for Android OS.
|
||||
|
||||
|
||||
The project was to Create the VLC User Documentation for Android Mobile Port which was previously hosted on VLC’s wiki pages. The major portion of this was to start everything from scratch including chapter separation, section organization and an engaging and easy to follow for both technical and non-technical users. The original proposal can be found here.
|
||||
|
||||
|
||||
PROJECT GOALS
|
||||
-------------
|
||||
|
||||
* Propose a new structure for documentation e.g. Chapter Separation, Sections etc
|
||||
* Proper balance between technical and non-technical descriptions to serve all kinds of users.
|
||||
* Adequate amount of screenshots in each section and other supporting media to make documentation more appealing.
|
||||
* Optimized for all Screen Sizes. Especially for Mobile Devices.
|
||||
* Ease of navigation
|
||||
|
||||
COMMUNITY BONDING
|
||||
-----------------
|
||||
|
||||
This period was mostly utilized for collecting more information and many internal meetings to shape the projects and bonding with fellow writers, developers(mentors). I got to know more about the VLC organization and the project. We decided to create a skeleton of the project and then follow a Issue-Merge Request-Review-Merge system to keep the commit history clean and maintain the proper review of the work before it is merged.
|
||||
|
||||
|
||||
I initially proposed that the new documentation should also use the same tools(Sphinx and GitLab Pages) because if in future we want to merge all the documentation into a single one, it will be easier to migrate and will provide a consistency across all documentations. Later I got to know that this will be an independent project and may not be merged since it solves a lot of problems. I was already familiar with the tools so it took no time to get started.
|
||||
|
||||
|
||||
Nicolas Pomepuy, who is the lead developer of VLC for Android was assigned as my primary mentor and Simon Latapie as secondary mentor.
|
||||
|
||||
|
||||
DOCUMENTATION DEVELOPMENT PHASE
|
||||
-------------------------------
|
||||
|
||||
Initial Preparation
|
||||
I first moved my existing demo documentation to an entirely new repository with only the skeleton at the suggestion of my mentor. It was necessary to keep the commit history clean. The skeleton contained the empty directories representing the chapter separation. I got to learn “how to properly develop a project and contribute to open source”. This was a major lesson that got me familiar with the Merge Request and Review system.
|
||||
|
||||
|
||||
The Development
|
||||
The next part was to frame the actual documentation pages and push to the repository. Since there was a significant time-zone difference we agreed to discuss by creating issues and sometimes my emails. There was one meeting every fortnight to check the process and discuss further development and blockers. Nicolas was really helpful and patient, answering each of my big-small queries.
|
||||
|
||||
Work Done
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<style>
|
||||
table,td,th {
|
||||
border-collapse:collapse;
|
||||
border: 1px solid #000000;
|
||||
}
|
||||
</style>
|
||||
<table>
|
||||
<tr>
|
||||
<td><strong>Documentation</strong></td>
|
||||
<td><a href="https://avinal.videolan.me/vlc-android-user/">VLC for Android User Documentation </a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Project Repository</strong>
|
||||
</td>
|
||||
<td><a href="https://code.videolan.org/avinal/vlc-android-user">Projects · Avinal Kumar / VLC for Android User Documentation</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Commits</strong>
|
||||
</td>
|
||||
<td><a href="https://code.videolan.org/avinal/vlc-android-user/-/commits/master">Commits · Avinal Kumar / VLC for Android User Documentation</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Issues/Discussions</strong>
|
||||
</td>
|
||||
<td><a href="https://code.videolan.org/avinal/vlc-android-user/-/issues">Issues · Avinal Kumar / VLC for Android User Documentation</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Merge Requests</strong>
|
||||
</td>
|
||||
<td><a href="https://code.videolan.org/avinal/vlc-android-user/-/merge_requests">Merge Requests · Avinal Kumar / VLC for Android User Documentation</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
Since the Android port of VLC can be installed on Android Smartphones/Tablets, Android TVs, Amazon Fire Devices and Chromebooks too, a full documentation will cover these all devices. Although these are different form factors, the features provided on each of them is exactly the same and the same documentation can be used for all these devices. As of now only Smartphones/Tablets are covered. And later additional pages will be added to reference different features/User Interface. Regardless of this addition the current documentation can serve a major part for all these form factors.
|
||||
Completed/Remaining
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td><strong>Chapters</strong>
|
||||
</td>
|
||||
<td><strong>Sections</strong>
|
||||
</td>
|
||||
<td><strong>Status</strong>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Settings</strong>
|
||||
</td>
|
||||
<td>
|
||||
<ul>
|
||||
<li>General Settings
|
||||
<li>Interface
|
||||
<li>Video
|
||||
<li>Subtitles
|
||||
<li>Audio
|
||||
<li>Casting
|
||||
<li>Advanced
|
||||
</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td><strong>ALL COMPLETED</strong>
|
||||
<p>
|
||||
<strong>FOR ALL FORM FACTORS</strong>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Video</strong>
|
||||
</td>
|
||||
<td>
|
||||
<ul>
|
||||
<li>Video Explorer
|
||||
<li>Video Player
|
||||
</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td><strong>COMPLETED FOR SMARTPHONES/TABLETS</strong>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Audio</strong>
|
||||
</td>
|
||||
<td>
|
||||
<ul>
|
||||
<li>Audio Explorer
|
||||
<li>Audio Player
|
||||
</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td><strong>COMPLETED FOR SMARTPHONES/TABLETS</strong>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Browse</strong>
|
||||
</td>
|
||||
<td>
|
||||
<ul>
|
||||
<li>Explorer
|
||||
<li>Local Network
|
||||
</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td><strong>ONLY SMB IN LOCAL NETWORK COMPLETED</strong>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Installation</strong>
|
||||
</td>
|
||||
<td>
|
||||
<ul>
|
||||
<li>Smartphones/Tablets
|
||||
<li>Android TV
|
||||
<li>Fire Devices
|
||||
<li>Chromebooks
|
||||
</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td><strong>COMPLETED FOR SMARTPHONES/TABLETS</strong>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>User Interface</strong>
|
||||
</td>
|
||||
<td>
|
||||
<ul>
|
||||
<li>Smartphones/Tablets
|
||||
<li>Android TV
|
||||
<li>Fire Devices
|
||||
<li>Chromebooks
|
||||
</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td><strong>COMPLETED FOR SMARTPHONES/TABLETS</strong>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Support</strong>
|
||||
</td>
|
||||
<td>
|
||||
<ul>
|
||||
<li>FAQs
|
||||
<li>Help
|
||||
</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td><strong>IN PROGRESS</strong>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Guidelines</strong>
|
||||
</td>
|
||||
<td>
|
||||
<ul>
|
||||
<li>Contribution Guideline
|
||||
<li>Screenshot Guidelines
|
||||
<li>READMEs
|
||||
</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td><strong>IN PROGRESS</strong>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
CHALLENGES
|
||||
----------
|
||||
|
||||
The major obstacle was to get screenshots for all form factors. Since screenshots were the major part of this documentation it was necessary to provide proper screenshots in each chapter and with every step. For Android TV and Smartphone this was solved by using emulators instead of actual devices, but to emulate the actual scenario in an emulator was sometimes very difficult.
|
||||
There were many occasions where I was not able to gather the exact information about devices other than smartphones/tables. Since all form factors share a common pool of features, my mentor suggested that I focus on smartphones/tables. And to create issues mentioning missing parts so that it could be solved later.
|
||||
|
||||
|
||||
THANKS
|
||||
------
|
||||
|
||||
I want to thank my mentors for being supporting and helpful. I want to thank every person at VLC and Google who were involved in this whole process. Thanks and Congrats to my fellow writer Abhishek Pratap Singh. This was a great opportunity to learn and meet awesome people. I learned a lot about Sphinx, reStructured Text and many other things.
|
||||
|
||||
@@ -1,96 +0,0 @@
|
||||
.. |redhat_logo| image:: /images/redhat_logo.png
|
||||
:width: 1.5em
|
||||
:align: middle
|
||||
:target: https://redhat.com
|
||||
|
||||
|
||||
**************************************
|
||||
My internship at Red Hat |redhat_logo|
|
||||
**************************************
|
||||
|
||||
:date: 2022-02-25 20:47
|
||||
:slug: i-am-loving-it-redhat
|
||||
:category: development
|
||||
:tags: kubernetes, redhat, docker, golang, tekton, openshift, intern
|
||||
:summary: I made it to the Red Hat as a DevTools intern. This post is about onboarding and how I prepared myself for working on the actual project.
|
||||
|
||||
|
||||
I have been contributing to open source for the last 3 years and Red Hat was one of the companies that I was very fond of. I must say all my contributions and consistency paid off, and I made it to the Red Hat as a DevTools intern. This post is about onboarding and how I prepared myself for working on the actual project.
|
||||
|
||||
|
||||
On the first day of my internship, I met two amazing teammates `Saytam <https://github.com/>`_ and `Utkarsh <https://github.com/>`_. We were also introduced to a Senior Software Engineer `Piyush Garg <https://github.com>`_ who later mentored us. The initial few meetings were more on the introduction and what to learn topics. Before I jump into more details let me explain first what does a **DevTools Developer/Engineer** do?
|
||||
|
||||
|
||||
What does a DevTools Developer/Engineer do?
|
||||
-------------------------------------------
|
||||
|
||||
From `MDN Web Docs <https://developer.mozilla.org/en-US/docs/Glossary/Developer_Tools>`_ **Developer tools (or "development tools" or short "DevTools") are programs that allow a developer to create, test, and debug software.** At RedHat, a lot of open source developer tools of industry standards are developed. There are many, OpenShift, Tekton, CodeReady containers, and many more.
|
||||
|
||||
.. |golang_logo| image:: /images/golang.png
|
||||
:width: 2.5em
|
||||
:align: top
|
||||
|
||||
Learning on the |golang_logo|
|
||||
-----------------------------
|
||||
|
||||
There was a lot of learning and still a lot to learn. In a meeting with my manager Pradeepto Bhattacharya, I was told that I will be working on TektonCD or OpenShift Pipelines, and both of them require a sound knowledge of Golang, CI/CD, Containers, Docker, and Kubernetes. I was familiar with CI/CD, containers, and Docker but never used Golang and Kubernetes. We were provided plenty of good resources and my teammates also helped with many awesome resources. I am listing all the resources with their category.
|
||||
|
||||
|
||||
`Golang <https://go.dev/>`_
|
||||
"""""""""""""""""""""""""""
|
||||
|
||||
.. image:: /images/goladder.png
|
||||
:class: float-md-right rounded ml-3
|
||||
:alt: Gopher on the ladder
|
||||
:height: 20em
|
||||
|
||||
One of Golang’s biggest advantages is that it offers the clarity and ease of use that other languages lack. Golang’s advantages make it easy for new programmers to quickly understand the language and for seasoned veterans to easily read each other’s code.
|
||||
|
||||
- `Official Go Documentation <https://go.dev/doc/>`_ - *Start from here*
|
||||
- `Go by Example <https://gobyexample.com/>`_ - *bite-size examples for most of the golang features*
|
||||
- `Golang tutorial series - GOLANGBOT.COM <https://golangbot.com/learn-golang-series/>`_ - *in-depth tutorial of golang*
|
||||
- `Effective Go <https://go.dev/doc/effective_go>`_ - *writing good golang programs*
|
||||
- `The Go Playground <https://go.dev/play/>`_ - *official online golang ide*
|
||||
- `The Go Programming Language - Book <https://www.gopl.io/>`_ *for learning advanced level golang*
|
||||
- `Golang Tutorial for Beginners | Full Go Course - TechWorld with Nana <https://youtu.be/yyUHQIec83I>`_ *if you prefer video tutorials, I don't :)*
|
||||
|
||||
`Docker <https://www.docker.com/>`_
|
||||
"""""""""""""""""""""""""""""""""""
|
||||
|
||||
Docker takes away repetitive, mundane configuration tasks and is used throughout the development lifecycle for fast, easy, and portable application development - desktop and cloud. Docker’s comprehensive end-to-end platform includes UIs, CLIs, APIs, and security that are engineered to work together across the entire application delivery lifecycle.
|
||||
|
||||
.. image:: /images/docker-architecture.png
|
||||
:class: float-md-right img-fluid my-3
|
||||
:alt: The Docker Architecture
|
||||
|
||||
|
||||
- `Docker and Containers - Katacoda <https://www.katacoda.com/courses/docker>`_ *interactive lessons on docker and containers*
|
||||
- `Docker for beginners <https://docker-curriculum.com/>`_
|
||||
- `Docker Tutorial for Beginners | TechWorld with Nana <https://youtu.be/3c-iBn73dDE>`_ *video tutorial*
|
||||
|
||||
`Kubernetes <https://kubernetes.io/>`_
|
||||
""""""""""""""""""""""""""""""""""""""
|
||||
|
||||
.. image:: /images/kubernetes-meme.png
|
||||
:width: 200
|
||||
:alt: Kubernetes tech
|
||||
:class: float-md-left border mr-3
|
||||
|
||||
|
||||
**Kubernetes** is the Greek word for a ship’s captain. We get the words Cybernetic and Gubernatorial from it. The Kubernetes project focuses on building a robust platform for running thousands of containers in production.
|
||||
|
||||
- `Learn Kubernetes - Katacoda <https://www.katacoda.com/courses/kubernetes>`_ *interactive lessons with kubernetes*
|
||||
- `kube by example <https://kubebyexample.com/>`_ *learn by doing*
|
||||
- `Kubernetes Tutorial for Beginners <https://youtu.be/X48VuDVv0do>`_ *video tutorial*
|
||||
|
||||
*Not so Minimal* Tekton Server
|
||||
------------------------------
|
||||
|
||||
In late January, we were asked to implement our learnings and deep dive into Kubernetes and TektonCD through an assignment project. Soon we realized that whatever we were learning so far was not even close to what we were going to implement. We were given a document containing the requirements of the applications we were supposed to create along with all the documentation and architectural diagrams.
|
||||
|
||||
|
||||
The application was called **Minimal Tekton Server**. It is a set of three different applications, i.e a server, a CLI, and a dashboard. In short, this application is supposed to *listen to custom resources being created and then transfer the request to Tekton API to create the corresponding resource on the OpenShift/Kubernetes cluster.*
|
||||
|
||||
|
||||
So are you interested in how it went? Please follow up with my `next blog <https://avinal.space/posts/development/lovely-dangerous-things-redhat.html>`_.
|
||||
|
||||
@@ -1,174 +0,0 @@
|
||||
.. |redhat_logo| image:: /images/redhat_logo.png
|
||||
:width: 1.5em
|
||||
:align: middle
|
||||
:target: https://redhat.com
|
||||
|
||||
.. |mks_logo| image:: /images/mks_logo.png
|
||||
:width: 1.5em
|
||||
:align: middle
|
||||
:target: https://github.com/MiniTeks
|
||||
|
||||
*******************************************
|
||||
Developing Minimal Tekton Server |mks_logo|
|
||||
*******************************************
|
||||
|
||||
:date: 2022-02-27 20:47
|
||||
:modified: 2022-03-07 22:47
|
||||
:slug: lovely-dangerous-things-redhat
|
||||
:category: development
|
||||
:tags: kubernetes, redhat, docker, golang, tekton, openshift, intern
|
||||
:summary: We will be designing and implementing an application that will be talking to Tekton APIs to create resources on a Kubernetes/OpenShift Cluster.
|
||||
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<p style="border: 2px solid var(--pink);border-radius: 7px;" align=center>This blog is a descreptive account of the development of Minimal Tekton Server. This is highly technical in nature, so please make sure that you have sufficient knowledge about Golang, Docker, Kubernetes and TektonCD. You can refer to my <a href="https://avinal.space/posts/development/i-am-loving-it-redhat.html">previous blog</a> to know about these topics.<p>
|
||||
|
||||
|
||||
As mentioned in my last blog, we were given to implement an application named **Minimal Tekton Server**. The problem statement reads:
|
||||
|
||||
.. epigraph::
|
||||
|
||||
We will be designing and implementing an application that will be talking to Tekton APIs to create resources on a Kubernetes/OpenShift Cluster. The application will expose some fields of the Tekton Resources which the user will provide and then this application will create Tekton resources by talking to Tekton APIs available on the cluster to create the resources based on the user-provided fields.
|
||||
|
||||
|
||||
There are three parts in this project for the application and two more parts for the CI/CD using TektonCD and Kubernetes/OpenShift. I will go through each part descriptively and try to explain what we did.
|
||||
|
||||
|
||||
|
||||
The Architecture of MKS
|
||||
-----------------------
|
||||
|
||||
The first task in the development of the Minimal Tekton Server was creating its architectural diagram. Our first diagram was trash compared to the final diagram. Yeah, we learned. I will be explaining our final(obviously) architectural diagram and try to make some sense out of band-aids and duct tapes.
|
||||
|
||||
.. image:: /images/mks-architecture.png
|
||||
:alt: The MKS Arhitecture
|
||||
:class: img-fluid my-3
|
||||
|
||||
Let me start with explaining **What are MKS Resources?**. I hope you know at least tidbits about Kubernetes and by the definition: *A resource is an endpoint in the Kubernetes API that stores a collection of API objects of a certain kind; for example, the built-in :code:`pods` resource contains a collection of Pod objects.* But developers soon realized that these in-built resources were not enough for the ever-growing applications of Kubernetes. Here `custom resource <https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/>`_ comes into the picture. *A custom resource is an extension of the Kubernetes API that is not necessarily available in a default Kubernetes installation.* To define a custom resource we use something called `Custom Resource Definition <https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/>`_. So MKS Resources are such custom resources that correspond to the TektonCD custom resources.
|
||||
|
||||
|
||||
.. image:: /images/venus-flytrap.gif
|
||||
:class: float-md-right ml-3
|
||||
:width: 250
|
||||
:alt: A venus flytrap engulphing an insect.
|
||||
|
||||
|
||||
Let us now focus on the box containing :code:`Controller` and :code:`API server`. The controller can be said as a stimulus-response mechanism. Take the analogy of a Venus Flytrap plant. The trap is initially open. There are :code:`trigger` hairs on the inside of the trap. Once an insect is detected, there is a change of state and the trap closes in a blick on the eye. The controller works the same way. It listens for the change in the state of the MKS resources and immediately transfers the request to the Tekton API to reflect the change in the corresponding Tekton resources. The changes can be creation, deletion, or updating. The API server ensures that there is a working connection between our controller and the Tekton API.
|
||||
|
||||
|
||||
|
||||
MKS Server also exposes APIs to introduce a change of state in the MKS resources. In technical terms these are called :code:`verbs`. There are five such verbs that we have exposed: :code:`create`, :code:`update`, :code:`get`, :code:`delete`, and :code:`list`. They can be utilized by a REST client, or in our case **MKS CLI** to introduce desired change. The MKS command-line interface provides commands and subcommands to do the desired tasks.
|
||||
|
||||
|
||||
Whenever there is a change in the state, there is a logic running inside the controller to react on that and that also affects our database. We store four datapoints in our database: :code:`created`, :code:`deleted`, :code:`completed`, and :code:`failed`. They tell us about the current statistcs of our MKS resource using a single-page web app called **MKS Dashboard** (or UI).
|
||||
|
||||
This was about the architecture of the Minimal Tekton Server. Let us jump into more technical stuff.
|
||||
|
||||
|
||||
How to implement a CRD controller?
|
||||
----------------------------------
|
||||
|
||||
During this assignment, something that took the most time and effort was the implementation of a controller for our custom resources. This isn't very hard if you go by the rules and do the things according to the well-defined documents and blogs since this is a standard step in the implementation of any custom resource controller. But did we follow the rules? Hell no! But this time, let us go step-by-step.
|
||||
|
||||
1. The first step is to define a :code:`CustomResourceDefinition` for our custom resource. Let us define a CRD called :code:`spacetime`. To do this you can write a YAML file like below.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# file: spacetime-crd.yaml
|
||||
apiVersion: apiextensions.k8s.io/v1
|
||||
kind: CustomResourceDefinition
|
||||
metadata:
|
||||
# name must match the spec fields below, and be in the form: <plural>.<group>
|
||||
name: spacetimes.example.com
|
||||
spec:
|
||||
# group name to use for REST API: /apis/<group>/<version>
|
||||
group: example.com
|
||||
# list of versions supported by this CustomResourceDefinition
|
||||
versions:
|
||||
- name: v1alpha1
|
||||
# Each version can be enabled/disabled by Served flag.
|
||||
served: true
|
||||
# One and only one version must be marked as the storage version.
|
||||
storage: true
|
||||
schema:
|
||||
openAPIV3Schema:
|
||||
type: object
|
||||
properties:
|
||||
spec:
|
||||
type: object
|
||||
properties:
|
||||
message:
|
||||
type: string
|
||||
# either Namespaced or Cluster
|
||||
scope: Namespaced
|
||||
names:
|
||||
# plural name to be used in the URL: /apis/<group>/<version>/<plural>
|
||||
plural: spacetimes
|
||||
# singular name to be used as an alias on the CLI and for display
|
||||
singular: spacetime
|
||||
# kind is normally the CamelCased singular type. Your resource manifests use this.
|
||||
kind: SpaceTime
|
||||
# shortNames allow shorter string to match your resource on the CLI
|
||||
shortNames:
|
||||
- st
|
||||
|
||||
You can learn more about the fields and options `here <https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/>`_. The CRD that we defined above corresponds to the :code:`CustomResource` given below. Once you apply the above file you will be able to see the :code:`spacetime` custom resource on your Kubernetes/OpenShift cluster.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# file: spacetime-cr.yaml
|
||||
apiVersion: spacetimes.example.com/v1alpha1
|
||||
kind: SpaceTime
|
||||
metadata:
|
||||
name: spacetime-cr
|
||||
spec:
|
||||
message: "Hello from space!"
|
||||
|
||||
Apply them using the following commands:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
kubectl apply -f spacetime-crd.yaml
|
||||
kubectl apply -f spacetime-cr.yaml
|
||||
|
||||
2. Once we have defined our custom resources, we need to define the types that will correspond to this custom resource definition. This can be done using :code:`k8s.io/apimachinery/pkg/apis/meta/v1` package written in golang. Did I tell you that this is all in golang? Well, now you know. Create a package structure for a golang project and add the definition of the type as given below.
|
||||
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
mkdir -p pkg/api/spacetime/v1alpha1
|
||||
touch pkg/api/spacetime/v1alpha1/{spacetime_types,register,doc}.go pkg/api/spacetime/register.go
|
||||
|
||||
|
||||
Add the following content to the corresponding files.
|
||||
|
||||
.. code-block:: golang
|
||||
|
||||
// file: /pkg/api/spacetime/v1alpha1/spacetime_types.go
|
||||
package v1alpha1
|
||||
|
||||
import (
|
||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
)
|
||||
|
||||
type SpaceTime struct {
|
||||
metav1.TypeMeta `json:",inline"`
|
||||
metav1.ObjectMeta `json:"metadata,omitempty"`
|
||||
|
||||
Spec SpaceTimeSpec `json:"spec"`
|
||||
}
|
||||
|
||||
type SpaceTimeSpec struct {
|
||||
Message string `json:"message"`
|
||||
}
|
||||
|
||||
type SpaceTimeList struct {
|
||||
metav1.TypeMeta `json:",inline"`
|
||||
metav1.ListMeta `json:"metadata"`
|
||||
|
||||
Items []SpaceTime `json:"items"`
|
||||
}
|
||||
|
||||
|
||||
**To be Continued**
|
||||
@@ -1,134 +0,0 @@
|
||||
**************************
|
||||
reStructuredText in GitHub
|
||||
**************************
|
||||
|
||||
:date: 2021-02-14 22:47
|
||||
:slug: rst-guide
|
||||
:category: development
|
||||
:tags: rst, github
|
||||
:summary: reStructuredText syntax
|
||||
|
||||
- Headers
|
||||
|
||||
.. code-block:: rst
|
||||
|
||||
Top Title
|
||||
=========
|
||||
|
||||
Sub Title
|
||||
---------
|
||||
|
||||
Sub Sub Title
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
- Images
|
||||
|
||||
- Direct
|
||||
|
||||
.. code-block:: rst
|
||||
|
||||
.. figure:: image-path-or-url
|
||||
:align: center
|
||||
:target: link-to-go-when-image-is-clicked
|
||||
:alt: alternative-text-if-any
|
||||
|
||||
- Indirect
|
||||
|
||||
.. code-block:: rst
|
||||
|
||||
.. |substitution| image:: image-path-or-url
|
||||
:target: link-to-go-when-image-is-clicked
|
||||
|
||||
You can use :code:`|substitution|` where you want to put your image.
|
||||
|
||||
- Links
|
||||
|
||||
.. code-block:: rst
|
||||
|
||||
`Link Text <link-itself>`__
|
||||
|
||||
- Lists
|
||||
|
||||
.. code-block:: rst
|
||||
|
||||
- item 1
|
||||
- item 2
|
||||
|
||||
* item 1
|
||||
* itme 2
|
||||
|
||||
#. item 1
|
||||
#. item 2
|
||||
|
||||
1. item 1
|
||||
2. item 2
|
||||
|
||||
First two lists are unordered next two are ordered.
|
||||
|
||||
- Code
|
||||
|
||||
- Inline
|
||||
|
||||
.. code-block:: rst
|
||||
|
||||
:code:`your-code`
|
||||
|
||||
- Code block
|
||||
|
||||
.. code-block:: rst
|
||||
|
||||
.. code-block:: language(optional)
|
||||
|
||||
Your code
|
||||
in multiple lines. You may enable line numbers too.
|
||||
|
||||
- Tables
|
||||
|
||||
.. code-block:: rst
|
||||
|
||||
+----------------+----------------+
|
||||
| Header Cell | Header Cell |
|
||||
+================+================+
|
||||
| Data cell | Data Cell |
|
||||
+----------------+----------------+
|
||||
| Header Cell | Header Cell |
|
||||
+----------------+----------------+
|
||||
|
||||
- Raw HTML block
|
||||
|
||||
.. code-block:: rst
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<put>
|
||||
your html code here
|
||||
</put>
|
||||
|
||||
- Notes, warnings
|
||||
|
||||
.. code-block:: rst
|
||||
|
||||
.. note::
|
||||
|
||||
Put your note here.
|
||||
|
||||
.. warning::
|
||||
|
||||
Put your warning here.
|
||||
|
||||
.. important::
|
||||
|
||||
Put instructions here.
|
||||
|
||||
.. admonition:: custom-text
|
||||
|
||||
Custom description here.
|
||||
|
||||
|
||||
These all are supported by GitHub very well. For more exhautive list specific to Sphinx see `this <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`__ link.
|
||||
|
||||
Tips
|
||||
----
|
||||
|
||||
- There must be a blank line before and after any directive. Such as after title or code block, tables etc.
|
||||
- The options and content of a directives must be 1 tab indented to the directives.
|
||||
@@ -1,157 +0,0 @@
|
||||
************************
|
||||
How I Created This Blog?
|
||||
************************
|
||||
|
||||
:date: 2021-01-26 16:47
|
||||
:updated: 2021-05-05 22:30
|
||||
:tags: blog, pelican, ssg
|
||||
:slug: twilight-blog
|
||||
:category: development
|
||||
:summary: As you would have guessed by now, this blog is created using one such awesome SSG named **Pelican**. Pelican is simple, customizable and offers lots of themes and plugins. Pelican is python based SSG and is available through :code:`pip`.
|
||||
|
||||
.. role:: html-raw(raw)
|
||||
:format: html
|
||||
|
||||
:html-raw:`<div class="alert alert-info" role="alert">This article may not be for you if you are a web developer. You already got better options. 😉</div>`
|
||||
|
||||
There are lots of ways to create a personal website or a blog. You can design your own user interface and write the backend code. But not everyone is a web developer. And here comes :abbr:`SSGs (Static Site Generator)` to the rescue. **Static Site Generators** are little more than just website generators. In general, if you are looking for a simple blog, its better to use SSG than writing a lot of html and css. They are simple and elegant. Easy to maintain and you can add lots of customizations to your site without breaking or bloating your blog. There are lots of SSGs, `Jekyll <https://jekyllrb.com/>`_, `Pelican <https://blog.getpelican.com/>`_ and more complex ones like `Gatsby <https://www.gatsbyjs.com/>`_, `Hugo <https://gohugo.io/>`_ .
|
||||
|
||||
As you would have guessed by now, this blog is created using one such awesome SSG named **Pelican**. Pelican is simple, customizable and offers lots of `themes <http://www.pelicanthemes.com/>`_ and `plugins <https://github.com/getpelican/pelican-plugins>`_. Pelican is python based SSG and is available through :code:`pip`.
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
# for reStructuredText only (recommended)
|
||||
python -m pip install pelican
|
||||
|
||||
# for markdown and reStructuredText both
|
||||
python -m pip install "pelican[markdown]"
|
||||
|
||||
You can start a pelican project by typing following command. It will create a basic template and build configurations.
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
pelican-quickstart
|
||||
|
||||
# output
|
||||
yourproject/
|
||||
├── content # Put your content here
|
||||
│ └── (pages)
|
||||
├── output # Output files
|
||||
├── tasks.py
|
||||
├── Makefile # Makefile to run build and publish command
|
||||
├── pelicanconf.py # Main settings file
|
||||
└── publishconf.py # Settings to use when ready to publish
|
||||
|
||||
Next step is to choose themes. As I said earlier there are lots of `themes <http://www.pelicanthemes.com/>`_ . And it is easy to create your own theme. Check `here <https://docs.getpelican.com/en/latest/themes.html>`_ to create your own theme. My choice of theme was `pelican-alchemy <https://nairobilug.github.io/pelican-alchemy/>`_ . This is a simple and great theme. Installing and removing themes in pelican is very easy.
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
# list all installed themes
|
||||
pelican-themes -l
|
||||
# output
|
||||
simple
|
||||
alchemy
|
||||
notmyidea
|
||||
|
||||
# install new theme
|
||||
pelican-themes -i theme-path
|
||||
|
||||
# remove a theme
|
||||
pelican-themes -r theme-name
|
||||
|
||||
To use a particular theme, set the :code:`THEME` variable in the **pelicanconf.py** file.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
THEME = 'alchemy'
|
||||
|
||||
You can also use a theme that is not installed if you have all the required theme files. Just set this variable to its path.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
THEME = 'path-to-theme-directory'
|
||||
|
||||
Various themes will have different feature, choose according to your need, or you can always add a feature through plugin. The next step is to build and check your blog. Pelican got it all set up.
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
# build your website
|
||||
make html
|
||||
# output
|
||||
"pelican" "/mnt/z/my_git/avinal.github.io/content" -o "/mnt/z/my_git/avinal.github.io/output" -s "/mnt/z/my_git/avinal.github.io/pelicanconf.py"
|
||||
Done: Processed 6 articles, 0 drafts, 1 page, 0 hidden pages and 0 draft pages in 2.43 seconds.
|
||||
|
||||
# build and test/serve on localhost
|
||||
make serve
|
||||
# output
|
||||
"pelican" -l "/mnt/z/my_git/avinal.github.io/content" -o "/mnt/z/my_git/avinal.github.io/output" -s "/mnt/z/my_git/avinal.github.io/pelicanconf.py"
|
||||
|
||||
Serving site at: 127.0.0.1:8000 - Tap CTRL-C to stop
|
||||
|
||||
Now open your browser and open `127.0.0.1:8000 <127.0.0.1:8000>`_ or `localhost:8000 <localhost:8000>`_. You should be able to see your new blog. Stop local server using :code:`CTRL+C`. Next step is to publish it to github pages. Pelican has tools for this too. But wait we can do something more interesting here. Why not let GitHub take care of both building and publishing? Just push this project to a GitHub repository and set up GitHub pages. See `this <https://pages.github.com/>`_ help for instructions on that. Before pushing to GitHub add this little script to your project.
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
#! /bin/bash
|
||||
## file: publi.sh
|
||||
|
||||
# install tools
|
||||
sudo apt-get install -y git make python3 python3-pip python3-setuptools python3-wheel
|
||||
|
||||
# setup github config
|
||||
git config user.email "your-email"
|
||||
git config user.name "your-username"
|
||||
|
||||
# install dependencies
|
||||
sudo pip3 install -r requirements.txt
|
||||
|
||||
# pelican commands - install theme put your theme in themes directory
|
||||
pelican-themes --install themes/theme-name
|
||||
|
||||
# publish to github pages
|
||||
ghp-import -m "Generate Pelican site" -b gh-pages output
|
||||
git push -f origin gh-pages
|
||||
|
||||
Now once your project is on GitHub, go to the **Actions** tab and click on *set up a workflow yourself* and paste the following code into the file and commit it.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# file: publish.yml
|
||||
name: Publish Blog
|
||||
on:
|
||||
push:
|
||||
branches: [ main ]
|
||||
pull_request:
|
||||
branches: [ main ]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: set up permissions
|
||||
run: chmod +x publi.sh
|
||||
- name: Run a multi-line script
|
||||
run: ./publi.sh
|
||||
|
||||
If you have done everything correctly then go to *https://username.github.io* and you should see your blog. From now on whenever you want to add an article, just write it, test locally and push. Yay your blog is ready.
|
||||
|
||||
:html-raw:`<h2 style=font-family:Exodar;font-weight:lighter;">But My Blog is Special 🥰</h2>`
|
||||
|
||||
My blog looks different, that is because I customized this theme a lot, especially headers, footers, and link appearance. And sorry I won't be publish my theme any time sooner. But I am listing down all the resources I have used for finally getting this result. You can always get my help by sending me a :html-raw:`<a href="mailto:avinal.xlvii@gmail.com" class="fa fa-envelope" style="text-decoration: none;"></a>` or starting a discussion on :html-raw:`<a href="https://github.com/avinal/avinal/discussions/2" class="fab fa-github" style="text-decoration: none;"></a>`.
|
||||
|
||||
* `Pelican Blog <https://blog.getpelican.com/>`_
|
||||
* `Pelican Docs <https://docs.getpelican.com/en/latest/>`_
|
||||
* `Pelican Themes <http://www.pelicanthemes.com/>`_
|
||||
* `Pelican Alchemy Theme <https://github.com/nairobilug/pelican-alchemy>`_
|
||||
* `Parallax Star background in CSS <https://codepen.io/saransh/pen/BKJun>`_
|
||||
* `Solar System animation <https://codepen.io/kowlor/pen/ZYYQoy>`_
|
||||
* :html-raw:`<a href="https://www.dafont.com/exodar.font" style="font-family: Exodar;font-weight: lighter;text-decoration: none;">EXODAR Font</a>`
|
||||
* `Overpass Mono <https://fonts.google.com/specimen/Overpass+Mono>`_
|
||||
* `Font Awesome <https://fontawesome.com/how-to-use/on-the-web/setup/hosting-font-awesome-yourself>`_
|
||||
|
||||
:html-raw:`<div class="alert alert-warning" role="alert">Some of the fonts I have used in my blog may not be available for commercial use. Please check if you intend to do so. Alternatively you may use fonts from this wonderful collection, <a href="https://www.websiteplanet.com/blog/best-free-fonts/">70+ Best Free Fonts for Designers – Free for Commercial Use in 2021</a> <i>(Thanks Ritta Blens for this suggestion)</i></div>`
|
||||
|
||||
|
||||
:html-raw:`<p align=center>Thanks!</p>`
|
||||
|
||||
@@ -1,160 +0,0 @@
|
||||
*******************************************************
|
||||
How I implemented WakaTime embeddable Coding Graph GHA?
|
||||
*******************************************************
|
||||
|
||||
:date: 2021-02-02 21:47
|
||||
:tags: wakatime, github-action, coding
|
||||
:category: development
|
||||
:slug: wakatime-readme
|
||||
:summary: f you use WakaTime to track your coding activity. You can add that to your README as a bar graph or embed it in your blog/portfolio. Just add this action to any of your repositories and there you have it.
|
||||
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<a href="https://github.com/avinal/Profile-Readme-WakaTime"><img src="https://raw.githubusercontent.com/avinal/Profile-Readme-WakaTime/b281d074ee75f9626b39d10e2e518c6a297208a3/waka.png" class="img-fluid"></a>
|
||||
|
||||
Implementation Details
|
||||
----------------------
|
||||
|
||||
This GitHub Action is divided into three parts. I didn't want to use Docker but it seems it doesn't work well without it. Let dive a little into technical details. Three parts are as below.
|
||||
|
||||
1. `main.py <https://github.com/avinal/Profile-Readme-WakaTime/blob/master/main.py>`_ python script. This script contains many procedures.
|
||||
|
||||
* `Getting JSON data file via WakaTime API <https://github.com/avinal/Profile-Readme-WakaTime/blob/master/main.py#L52>`_
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
def get_stats() -> list:
|
||||
...
|
||||
return data_list
|
||||
|
||||
|
||||
This function parses the JSON file received and scraps out the useful data as a list of lists. Data scraped are language list, time spent on each language, percentage of the time, start date, and end date. For this action, I have limited the number of languages to 5 however it should be very easy to increase that number.
|
||||
|
||||
* `Setting the Timeline <https://github.com/avinal/Profile-Readme-WakaTime/blob/master/main.py#L13>`_
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
def this_week(dates: list) -> str:
|
||||
...
|
||||
return f"Coding Activity During: {week_start.strftime('%d %B, %Y')} to {week_end.strftime('%d %B, %Y')}"
|
||||
|
||||
The start date and end date scraped in the last function are used here to set the timeline. Because date in JSON is provided in UTC as below :
|
||||
|
||||
.. code-block:: json
|
||||
|
||||
date: "YYYY-MM-DDTHH:MM:SSZ"
|
||||
|
||||
I striped it to simple dates only. We can set them manually by taking the current time from the system. But that method is flawed. But this method ensures that JSON was received latest and the request was successful. Any anomaly will point to a failure in request.
|
||||
|
||||
|
||||
* `Creating a bar graph <https://github.com/avinal/Profile-Readme-WakaTime/blob/master/main.py#L21>`_
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
def make_graph(data: list):
|
||||
...
|
||||
savefig(...)
|
||||
|
||||
|
||||
Lastly, it is time to generate the graph and save them as an image. This function uses the data scraped in the first step. Creating a bar graph using `matplotlib` is easy. Decorating was a bit difficult. I wanted this graph to merge with GitHub's look so I chose to color the bar as GitHub colors the languages. That data is stored as `colors.json`. Many of the languages have slightly different spelling in GitHub as compared to WakaTime. So some languages are shown in default color. That can be improved if we notice that language and change its color manually. Lastly, the graph is saved both as SVG and PNG. SVGs are better to put on a responsive page.
|
||||
|
||||
|
||||
2. `entrypoint.py <https://github.com/avinal/Profile-Readme-WakaTime/blob/master/entrypoint.sh>`_ shell script. This shell script clones the repository copies the image and pushes changes to the master. There were several problems. First of all authentication. This was solved by using a remote repository address using GitHub Token. And it seems that GitHub doesn't allow to commit without a username and email. So I used **github-actions** bot email.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
remote_repo-"https://${GITHUB_ACTOR}:${INPUT_GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
|
||||
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
||||
git config user.name "GitHub Actions"
|
||||
|
||||
|
||||
|
||||
:code:`41898282` is the id assigned to the github-actions bot. Don't ask where I found them 🙂.
|
||||
|
||||
Another problem was to separate repository name from combined *username/repository-name* provided by `${GITHUB_REPOSITORY}`. GitHub doesn't provides a direct way to get just the repo name. We used *Internal Field Separator*. It returns an array and works similar to :code:`split()` command in Python and Java.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# '/' is the seperator
|
||||
IFS-'/' read -ra reponame <<< "${GITHUB_REPOSITORY}"
|
||||
# returned {username, repository}
|
||||
repository-"${reponame[1]}"
|
||||
|
||||
|
||||
After that, all other commands are pretty straight. Commit the added files and push them.
|
||||
|
||||
3. `Dockerfile <https://github.com/avinal/Profile-Readme-WakaTime/blob/master/Dockerfile>`_ **IMPORTANT** It took a lot of time to reach this state 🥱. This is where all the magic happens. I am running `ubuntu:latest` inside the container. I first update the distribution. Then install the required python packages. Lastly, I invoke the python script and shell script.
|
||||
|
||||
There was an almost impossible problem, I searched hundreds of posts that *how can I access the generated files inside Docker container*, but no luck. But at last, I found a workaround(obviously otherwise you wouldn't be reading this by now 🤣) each command is run in a separate virtual sub-container. As the command ends its output is also lost but not when you club multiple commands together. At least not until every command is finished. The generated files are available to the next clubbed process. I did that by combining the python script run and shell script run.
|
||||
|
||||
.. code-block:: dockerfile
|
||||
|
||||
CMD python3 /main.py && /entrypoint.sh
|
||||
|
||||
This part is the smallest yet took the most time and tries while developing this action.
|
||||
|
||||
How to use this GitHub Actions?
|
||||
-------------------------------
|
||||
|
||||
1. First get your WakaTime API Key. You can get it from your [WakaTime](https://wakatime.com) account settings.
|
||||
2. Save WakaTime API Key to Repository Secret. Find that by clicking the Settings tab. Keep the name of the secret as **WAKATIME_API_KEY**.
|
||||
3. Add the following line in your README.md of your repo.
|
||||
|
||||
.. code-block:: html
|
||||
|
||||
<img src-"https://github.com/<username>/<repository-name>/blob/<branch-name>/images/stat.svg" alt-"Alternative Text"/>
|
||||
Example: <img src-"https://github.com/avinal/avinal/blob/main/images/stat.svg" alt-"Avinal WakaTime Activity"/>
|
||||
|
||||
|
||||
You can use this method to embed in web pages too. **Do not use the markdown method of inserting images. It does not work sometimes.**
|
||||
|
||||
4. Click the **Action** tab and **choose to set up a workflow yourself**.
|
||||
5. Copy the following code into the opened file, you can search for **WakaTime Stat** in the marketplace tab for assistance.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
name: WakaTime status update
|
||||
|
||||
on:
|
||||
schedule:
|
||||
# Runs at 12 am '0 0 * * *' UTC
|
||||
- cron: "1 0 * * *"
|
||||
|
||||
jobs:
|
||||
update-readme:
|
||||
name: Update the WakaTime Stat
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
# Use avinal/Profile-Readme-WakaTime@<latest-release-tag> for latest stable release
|
||||
# Do not change the line below except the word master with tag number maybe
|
||||
# If you have forked this project you can use <username>/Profile-Readme-WakaTime@master instead
|
||||
- uses: avinal/Profile-Readme-WakaTime@master
|
||||
with:
|
||||
# WakaTime API key stored in secrets, do not directly paste it here
|
||||
WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
|
||||
# Automatic github token
|
||||
GITHUB_TOKEN: ${{ github.token }}
|
||||
# Branch - newer GitHub repositories have "main" as default branch, change to main in that case, default is master
|
||||
BRANCH: "master"
|
||||
# Manual Commit messages - write your own messages here
|
||||
COMMIT_MSG: "Automated Coding Activity Update :alien:"
|
||||
|
||||
|
||||
6. Please wait till 12 AM UTC to run this workflow automatically. Or you can force run it by going to the Actions tab. Or you can add the following lines under `on:` to run with every push. Search for 12 AM UTC to find the equivalent time in your time zone.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ master ]
|
||||
schedule:
|
||||
- cron: '1 0 * * *'
|
||||
|
||||
My Coding Activity
|
||||
------------------
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<img class="img-fluid" src="https://raw.githubusercontent.com/avinal/avinal/main/images/stat.svg">
|
||||
|
||||
@@ -1,95 +0,0 @@
|
||||
**********************************
|
||||
Move WSL 2 Safely to another Drive
|
||||
**********************************
|
||||
|
||||
:date: 2020-12-31 19:07
|
||||
:tags: wsl, wsl2
|
||||
:category: development
|
||||
:slug: wsl1
|
||||
:summary: It is real pain when you have small SSD and Windows Subsystem for Linux (WSL) is growing exponentially in size. There is no easy way to move the WSL installation to another drive. Here in this blog I will discuss how to tackle this problem with bite size steps.
|
||||
|
||||
It is real pain when you have small SSD and Windows Subsystem for Linux (WSL) is growing exponentially in size. There is no easy way to move
|
||||
the WSL installation to another drive. Here in this blog I will discuss how to tackle this problem with bite size steps.
|
||||
|
||||
.. |powershell| image:: /images/powershell.png
|
||||
:width: 5%
|
||||
:align: middle
|
||||
|
||||
.. |command-line| image:: /images/command-line.png
|
||||
:width: 5%
|
||||
:align: middle
|
||||
|
||||
.. |windows10| image:: /images/windows10.png
|
||||
:width: 5%
|
||||
:align: middle
|
||||
:alt: WinKey
|
||||
|
||||
.. role:: html-raw(raw)
|
||||
:format: html
|
||||
|
||||
1. Open a PowerShell |powershell| or Command Prompt |command-line| with *Admin* access. For this you can use |windows10| + X shortcut and select **Windows PowerShell(Admin)**.
|
||||
2. Check if the WSL 2 installation you are planning to move is is currently running/stopped.
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
PS C:\Users\Avinal> wsl -l -v
|
||||
PS C:\Users\Avinal>
|
||||
NAME STATE VERSION
|
||||
* Ubuntu Running 2
|
||||
Kali Stopped 2
|
||||
|
||||
3. If its running then you must stop the particular WSL distribution. (*Ubuntu* used as example)
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
PS C:\Users\Avinal> wsl -t Ubuntu
|
||||
|
||||
4. Export to some folder. (Here exporting *Ubuntu* as *ubuntu-ex.tar* to *Z:\wsl2*)
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
PS C:\Users\Avinal> wsl --export Ubuntu "Z:\export\ubuntu-ex.tar"
|
||||
|
||||
5. Unregister previous WSL installation
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
PS C:\Users\Avinal> wsl --unregister Ubuntu
|
||||
|
||||
6. Create a new folder and import your WSL installation to that folder.
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
PS C:\Users\Avinal> New-Item -Path "Z:\wsl2" -ItemType Directory
|
||||
|
||||
Directory: Z:\
|
||||
|
||||
Mode LastWriteTime Length Name
|
||||
---- ------------- ------ ----
|
||||
d----- 31-12-2020 21:03 wsl2
|
||||
|
||||
PS C:\Users\Avinal> wsl --import Ubuntu "Z:\wsl2" "Z:\export\ubuntu-ex.tar"
|
||||
|
||||
7. Check after import is complete
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
PS C:\Users\Avinal> wsl -l -v
|
||||
PS C:\Users\Avinal>
|
||||
NAME STATE VERSION
|
||||
* Ubuntu Running 2
|
||||
Kali Stopped 2
|
||||
|
||||
8. Mark one of your WSL distribution as *(default)*.
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
PS C:\Users\Avinal> wsl -s Ubuntu
|
||||
|
||||
9. After exporting your default user will be set as :html-raw:`<i style="color:red">root</i>` , to change it to your desired username, run following command
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
PS C:\Users\Avinal> ubuntu config --default-user user_name
|
||||
|
||||
10. Finally run :code:`wsl` and you have successfully moved your WSL 2 installation to another drive.
|
||||
@@ -1 +0,0 @@
|
||||
avinal.space
|
||||
|
Before Width: | Height: | Size: 5.7 KiB |
|
Before Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 4.6 KiB |
|
Before Width: | Height: | Size: 926 B |
|
Before Width: | Height: | Size: 1.3 KiB |
|
Before Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 4.4 KiB |
|
Before Width: | Height: | Size: 4.3 KiB |
|
Before Width: | Height: | Size: 9.1 KiB |
|
Before Width: | Height: | Size: 3.2 KiB |
@@ -1,29 +0,0 @@
|
||||
<?xml version="1.0" standalone="no"?>
|
||||
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN"
|
||||
"http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
|
||||
<svg version="1.0" xmlns="http://www.w3.org/2000/svg"
|
||||
width="700.000000pt" height="700.000000pt" viewBox="0 0 700.000000 700.000000"
|
||||
preserveAspectRatio="xMidYMid meet">
|
||||
<metadata>
|
||||
Created by potrace 1.11, written by Peter Selinger 2001-2013
|
||||
</metadata>
|
||||
<g transform="translate(0.000000,700.000000) scale(0.100000,-0.100000)"
|
||||
fill="#000000" stroke="none">
|
||||
<path d="M3458 6985 c-2 -1 -43 -5 -93 -9 -49 -3 -103 -8 -120 -10 -475 -64
|
||||
-918 -318 -1215 -696 -91 -115 -93 -119 -152 -220 -62 -108 -49 -82 -260 -545
|
||||
-87 -192 -165 -364 -173 -381 -8 -16 -27 -59 -43 -95 -16 -35 -43 -93 -60
|
||||
-129 -75 -161 -92 -202 -86 -211 3 -5 0 -9 -6 -9 -13 0 -13 2 40 -165 21 -66
|
||||
66 -208 100 -315 34 -107 70 -220 80 -250 l17 -55 -31 -7 c-17 -4 -44 -10 -61
|
||||
-13 -16 -3 -38 -8 -47 -11 -9 -3 -27 -7 -40 -9 -13 -3 -94 -21 -181 -42 l-158
|
||||
-37 -63 -116 c-35 -63 -78 -142 -96 -175 -42 -78 -89 -164 -160 -295 -101
|
||||
-186 -119 -220 -317 -585 -108 -198 -209 -385 -225 -415 -17 -30 -48 -87 -69
|
||||
-127 l-39 -72 2 -543 3 -543 572 0 c387 1 573 -3 574 -10 0 -5 1 -206 2 -445
|
||||
l2 -434 2345 -1 2345 0 5 445 5 445 570 0 570 0 3 549 2 550 -112 205 c-61
|
||||
113 -125 231 -141 261 -16 30 -53 98 -82 150 -29 52 -67 122 -85 155 -18 33
|
||||
-45 83 -60 110 -42 76 -79 143 -118 215 -19 36 -62 115 -95 175 -33 61 -70
|
||||
128 -82 150 -156 287 -192 349 -210 355 -11 5 -123 32 -250 60 -126 29 -234
|
||||
56 -238 60 -5 4 23 108 63 231 39 123 94 295 121 382 l50 158 -44 102 c-91
|
||||
209 -526 1155 -562 1222 -143 268 -354 500 -610 670 -305 203 -621 305 -987
|
||||
318 -54 2 -99 3 -100 2z"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 1.6 KiB |
@@ -1,19 +0,0 @@
|
||||
{
|
||||
"name": "Avinal",
|
||||
"short_name": "Avinal",
|
||||
"icons": [
|
||||
{
|
||||
"src": "/android-chrome-192x192.png",
|
||||
"sizes": "192x192",
|
||||
"type": "image/png"
|
||||
},
|
||||
{
|
||||
"src": "/android-chrome-512x512.png",
|
||||
"sizes": "512x512",
|
||||
"type": "image/png"
|
||||
}
|
||||
],
|
||||
"theme_color": "#00aba9",
|
||||
"background_color": "#00aba9",
|
||||
"display": "standalone"
|
||||
}
|
||||
|
Before Width: | Height: | Size: 145 KiB |
|
Before Width: | Height: | Size: 141 KiB |
|
Before Width: | Height: | Size: 903 B |
|
Before Width: | Height: | Size: 184 KiB |
|
Before Width: | Height: | Size: 83 KiB |
|
Before Width: | Height: | Size: 21 KiB |
|
Before Width: | Height: | Size: 372 KiB |
|
Before Width: | Height: | Size: 163 KiB |
|
Before Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 2.7 KiB |
|
Before Width: | Height: | Size: 905 KiB |
|
Before Width: | Height: | Size: 7.0 KiB |
|
Before Width: | Height: | Size: 2.4 MiB |
|
Before Width: | Height: | Size: 434 B |
@@ -1,6 +0,0 @@
|
||||
********
|
||||
About Me
|
||||
********
|
||||
|
||||
:slug: about-me
|
||||
|
||||
@@ -1,28 +0,0 @@
|
||||
*****************************
|
||||
Introduction to Prime Numbers
|
||||
*****************************
|
||||
|
||||
:date: 2021-01-09 22:29
|
||||
:tags: prime, primenumbers
|
||||
:category: prime
|
||||
:slug: prime1
|
||||
:summary: A prime is a positive integer *p* having exactly two positive divisors, namely *1* and *p*. An integer *n* is composite if *n* > *1* and *n* is not prime. (The number 1 is considered neither prime nor composite.)
|
||||
|
||||
.. epigraph::
|
||||
|
||||
A prime is a positive integer *p* having exactly two positive divisors, namely *1* and *p*. An integer *n* is composite if *n* > *1* and *n* is not prime. (The number 1 is considered neither prime nor composite.)
|
||||
|
||||
We can frame a brute force algorithm for checking primality of numbers using the above statement.
|
||||
|
||||
.. code-block:: cpp
|
||||
|
||||
bool is_prime(int number) {
|
||||
int factor = 0;
|
||||
for (int i = 0; i <= number; ++i) {
|
||||
if (number % i == 0) {
|
||||
factor++;
|
||||
}
|
||||
}
|
||||
return (factor == 2)? true : false;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
[build]
|
||||
command = "npm run build"
|
||||
publish = "dist"
|
||||
|
||||
[build.environment]
|
||||
NODE_VERSION = "22"
|
||||
|
||||
[[headers]]
|
||||
for = "/*"
|
||||
[headers.values]
|
||||
X-Frame-Options = "DENY"
|
||||
X-Content-Type-Options = "nosniff"
|
||||
Referrer-Policy = "strict-origin-when-cross-origin"
|
||||
Permissions-Policy = "camera=(), microphone=(), geolocation=()"
|
||||
X-XSS-Protection = "1; mode=block"
|
||||
Content-Security-Policy = "default-src 'self'; script-src 'self' 'unsafe-inline' https://cal.com; style-src 'self' 'unsafe-inline' https://fonts.googleapis.com; img-src 'self' https: data:; font-src 'self' https://fonts.gstatic.com; connect-src 'self' https://api.listenbrainz.org https://coverartarchive.org https://itunes.apple.com https://api.github.com https://wakatime.com; frame-src https://cal.com;"
|
||||
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"name": "avinal.github.io",
|
||||
"version": "1.0.0",
|
||||
"description": "",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "astro dev",
|
||||
"build": "astro build",
|
||||
"preview": "astro preview",
|
||||
"check": "astro check"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/avinal/avinal.github.io.git"
|
||||
},
|
||||
"keywords": [],
|
||||
"author": "",
|
||||
"license": "ISC",
|
||||
"bugs": {
|
||||
"url": "https://github.com/avinal/avinal.github.io/issues"
|
||||
},
|
||||
"homepage": "https://github.com/avinal/avinal.github.io#readme",
|
||||
"dependencies": {
|
||||
"@astrojs/rss": "^4.0.18",
|
||||
"@astrojs/sitemap": "^3.7.2",
|
||||
"@fontsource/iosevka": "^5.2.5",
|
||||
"@fontsource/iosevka-aile": "^5.2.5",
|
||||
"astro": "^6.3.5",
|
||||
"rehype-autolink-headings": "^7.1.0",
|
||||
"rehype-slug": "^6.0.0",
|
||||
"unist-util-visit": "^5.1.0"
|
||||
}
|
||||
}
|
||||
@@ -1,10 +0,0 @@
|
||||
#! /bin/bash
|
||||
|
||||
# install tools
|
||||
sudo apt-get install -y git make python3 python3-pip python3-setuptools python3-wheel
|
||||
|
||||
# install dependencies
|
||||
sudo pip3 install -r requirements.txt
|
||||
|
||||
# publish to github pages
|
||||
sudo make github
|
||||
@@ -1,78 +0,0 @@
|
||||
#!/usr/bin/env python
|
||||
# -*- coding: utf-8 -*- #
|
||||
|
||||
AUTHOR = 'Avinal'
|
||||
HIDE_AUTHORS = True
|
||||
SITENAME = 'Be My SpaceTime'
|
||||
SITESUBTITLE = '눈치'
|
||||
SITEURL = 'https://avinal.space'
|
||||
THEME = 'themes/alchemy'
|
||||
PATH = 'content'
|
||||
MAIL = 'blog@avinal.space'
|
||||
TIMEZONE = 'Asia/Kolkata'
|
||||
DEFAULT_LANG = 'en'
|
||||
|
||||
# Feed generation is usually not desired when developing
|
||||
FEED_ALL_ATOM = None
|
||||
CATEGORY_FEED_ATOM = None
|
||||
TRANSLATION_FEED_ATOM = None
|
||||
AUTHOR_FEED_ATOM = None
|
||||
AUTHOR_FEED_RSS = None
|
||||
|
||||
|
||||
# URL Flexibility
|
||||
ARTICLE_URL = 'posts/{category}/{slug}.html'
|
||||
ARTICLE_SAVE_AS = ARTICLE_URL
|
||||
PAGE_URL = 'pages/{slug}.html'
|
||||
PAGE_SAVE_AS = PAGE_URL
|
||||
|
||||
# static content setting
|
||||
STATIC_PATHS = ['extras', 'images']
|
||||
EXTRA_PATH_METADATA = {
|
||||
'extras/android-chrome-192x192.png': {'path': 'android-chrome-192x192.png'},
|
||||
'extras/android-chrome-512x512.png': {'path': 'android-chrome-512x512.png'},
|
||||
'extras/apple-touch-icon.png': {'path': 'apple-touch-icon.png'},
|
||||
'extras/browserconfig.xml': {'path': 'browserconfig.xml'},
|
||||
'extras/favicon-16x16.png': {'path': 'favicon-16x16.png'},
|
||||
'extras/favicon-32x32.png': {'path': 'favicon-32x32.png'},
|
||||
'extras/favicon.ico': {'path': 'favicon.ico'},
|
||||
'extras/site.webmanifest': {'path': 'site.webmanifest'},
|
||||
'extras/mstile-150x150.png': {'path': 'mstile-150x150.png'},
|
||||
'extras/mstile-70x70.png': {'path': 'mstile-70x70.png'},
|
||||
'extras/mstile-310x310.png': {'path': 'mstile-310x310.png'},
|
||||
'extras/mstile-144x144.png': {'path': 'mstile-144x144.png'},
|
||||
'extras/safari-pinned-tab.svg': {'path': 'safari-pinned-tab.svg'},
|
||||
'extras/CNAME': {'path': 'CNAME'},
|
||||
}
|
||||
|
||||
RFG_FAVICONS = True
|
||||
|
||||
LINKS = [
|
||||
('gsoc', 'https://gsoc.avinal.space')
|
||||
]
|
||||
# icons
|
||||
ICONS = [
|
||||
('github', "https://github.com/avinal"),
|
||||
('linkedin', 'https://www.linkedin.com/in/avinal/'),
|
||||
('instagram', 'https://instagram.com/avinal.k'),
|
||||
('calendar', 'https://meet.avinal.space')
|
||||
]
|
||||
|
||||
DIRECT_TEMPLATES = ('index', 'tags', 'categories', 'archives', 'sitemap')
|
||||
SITEMAP_SAVE_AS = 'sitemap.xml'
|
||||
|
||||
DEFAULT_PAGINATION = 5
|
||||
|
||||
PYGMENTS_STYLE = 'manni'
|
||||
|
||||
# Comments config
|
||||
|
||||
FORM_COMMENTS = True
|
||||
|
||||
FORM_PROPERTIES = {
|
||||
'name' : 'entry.982725972',
|
||||
'email':'entry.1652853191',
|
||||
'link':'entry.1641222305',
|
||||
'comment':'entry.1062656232',
|
||||
'action':'https://docs.google.com/forms/u/0/d/e/1FAIpQLSfL9T8WBRm-Ac2uyu74lJXSYOqAuF6lLIUAulRArCsuiI1ZRQ/formResponse'
|
||||
}
|
||||
|
After Width: | Height: | Size: 6.9 KiB |
|
After Width: | Height: | Size: 18 KiB |
|
After Width: | Height: | Size: 5.8 KiB |
@@ -2,8 +2,8 @@
|
||||
<browserconfig>
|
||||
<msapplication>
|
||||
<tile>
|
||||
<square150x150logo src="/mstile-150x150.png"/>
|
||||
<TileColor>#00aba9</TileColor>
|
||||
<square150x150logo src="/logo-static.svg"/>
|
||||
<TileColor>#2563eb</TileColor>
|
||||
</tile>
|
||||
</msapplication>
|
||||
</browserconfig>
|
||||
|
After Width: | Height: | Size: 923 B |
|
After Width: | Height: | Size: 1.7 KiB |
|
After Width: | Height: | Size: 15 KiB |
|
After Width: | Height: | Size: 1.3 MiB |
|
After Width: | Height: | Size: 938 KiB |
|
After Width: | Height: | Size: 6.6 MiB |
|
After Width: | Height: | Size: 1.4 MiB |
|
After Width: | Height: | Size: 95 KiB |
|
After Width: | Height: | Size: 7.8 KiB |
|
After Width: | Height: | Size: 721 KiB |
|
After Width: | Height: | Size: 53 KiB |
|
After Width: | Height: | Size: 92 KiB |
|
After Width: | Height: | Size: 105 KiB |
|
After Width: | Height: | Size: 170 KiB |
|
After Width: | Height: | Size: 15 KiB |
|
After Width: | Height: | Size: 521 KiB |
|
After Width: | Height: | Size: 17 KiB |
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
|
After Width: | Height: | Size: 217 KiB |
|
After Width: | Height: | Size: 185 KiB |
|
After Width: | Height: | Size: 2.3 MiB |
|
After Width: | Height: | Size: 242 KiB |
|
After Width: | Height: | Size: 105 KiB |
|
After Width: | Height: | Size: 210 KiB |
|
After Width: | Height: | Size: 56 KiB |
|
After Width: | Height: | Size: 7.6 KiB |
|
After Width: | Height: | Size: 117 KiB |
|
After Width: | Height: | Size: 35 KiB |
|
After Width: | Height: | Size: 2.0 MiB |
|
After Width: | Height: | Size: 72 KiB |
|
After Width: | Height: | Size: 3.1 KiB |
|
After Width: | Height: | Size: 598 KiB |