mirror of
https://github.com/avinal/avinal.github.io.git
synced 2026-07-04 07:40:09 +05:30
783 lines
95 KiB
XML
783 lines
95 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<feed xmlns="http://www.w3.org/2005/Atom"><title>Be My SpaceTime - development</title><link href="https://avinal.space/" rel="alternate"></link><link href="https://avinal.space/feeds/development.atom.xml" rel="self"></link><id>https://avinal.space/</id><updated>2022-03-07T22:47:00+05:30</updated><subtitle>눈치</subtitle><entry><title>Developing Minimal Tekton Server</title><link href="https://avinal.space/posts/development/lovely-dangerous-things-redhat.html" rel="alternate"></link><published>2022-02-27T20:47:00+05:30</published><updated>2022-03-07T22:47:00+05:30</updated><author><name>Avinal</name></author><id>tag:avinal.space,2022-02-27:/posts/development/lovely-dangerous-things-redhat.html</id><summary type="html"><p class="first last">We will be designing and implementing an application that will be talking to Tekton APIs to create resources on a Kubernetes/OpenShift Cluster.</p>
|
||
</summary><content type="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><p>As mentioned in my last blog, we were given to implement an application named <strong>Minimal Tekton Server</strong>. The problem statement reads:</p>
|
||
<blockquote class="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.</blockquote>
|
||
<p>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.</p>
|
||
<div class="section" id="the-architecture-of-mks">
|
||
<h2>The Architecture of MKS</h2>
|
||
<p>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.</p>
|
||
<img alt="The MKS Arhitecture" class="img-fluid my-3" src="/images/mks-architecture.png" />
|
||
<p>Let me start with explaining <strong>What are MKS Resources?</strong>. I hope you know at least tidbits about Kubernetes and by the definition: <em>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.</em> But developers soon realized that these in-built resources were not enough for the ever-growing applications of Kubernetes. Here <a class="reference external" href="https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/">custom resource</a> comes into the picture. <em>A custom resource is an extension of the Kubernetes API that is not necessarily available in a default Kubernetes installation.</em> To define a custom resource we use something called <a class="reference external" href="https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/">Custom Resource Definition</a>. So MKS Resources are such custom resources that correspond to the TektonCD custom resources.</p>
|
||
<img alt="A venus flytrap engulphing an insect." class="float-md-right ml-3" src="/images/venus-flytrap.gif" style="width: 250px;" />
|
||
<p>Let us now focus on the box containing <code>Controller</code> and <code>API server</code>. 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</code> 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.</p>
|
||
<p>MKS Server also exposes APIs to introduce a change of state in the MKS resources. In technical terms these are called <code>verbs</code>. There are five such verbs that we have exposed: <code>create</code>, <code>update</code>, <code>get</code>, <code>delete</code>, and <code>list</code>. They can be utilized by a REST client, or in our case <strong>MKS CLI</strong> to introduce desired change. The MKS command-line interface provides commands and subcommands to do the desired tasks.</p>
|
||
<p>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>, <code>deleted</code>, <code>completed</code>, and <code>failed</code>. They tell us about the current statistcs of our MKS resource using a single-page web app called <strong>MKS Dashboard</strong> (or UI).</p>
|
||
<p>This was about the architecture of the Minimal Tekton Server. Let us jump into more technical stuff.</p>
|
||
</div>
|
||
<div class="section" id="how-to-implement-a-crd-controller">
|
||
<h2>How to implement a CRD controller?</h2>
|
||
<p>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.</p>
|
||
<ol class="arabic simple">
|
||
<li>The first step is to define a <code>CustomResourceDefinition</code> for our custom resource. Let us define a CRD called <code>spacetime</code>. To do this you can write a YAML file like below.</li>
|
||
</ol>
|
||
<div class="highlight"><pre><span></span><span class="c1"># file: spacetime-crd.yaml</span><span class="w"></span>
|
||
<span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">apiextensions.k8s.io/v1</span><span class="w"></span>
|
||
<span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">CustomResourceDefinition</span><span class="w"></span>
|
||
<span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
|
||
<span class="c1"># name must match the spec fields below, and be in the form: &lt;plural&gt;.&lt;group&gt;</span><span class="w"></span>
|
||
<span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">spacetimes.example.com</span><span class="w"></span>
|
||
<span class="nt">spec</span><span class="p">:</span><span class="w"></span>
|
||
<span class="c1"># group name to use for REST API: /apis/&lt;group&gt;/&lt;version&gt;</span><span class="w"></span>
|
||
<span class="nt">group</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example.com</span><span class="w"></span>
|
||
<span class="c1"># list of versions supported by this CustomResourceDefinition</span><span class="w"></span>
|
||
<span class="nt">versions</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1alpha1</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># Each version can be enabled/disabled by Served flag.</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">served</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># One and only one version must be marked as the storage version.</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">storage</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">openAPIV3Schema</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">object</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">properties</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">spec</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">object</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">properties</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">message</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">string</span><span class="w"></span>
|
||
<span class="c1"># either Namespaced or Cluster</span><span class="w"></span>
|
||
<span class="nt">scope</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Namespaced</span><span class="w"></span>
|
||
<span class="nt">names</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># plural name to be used in the URL: /apis/&lt;group&gt;/&lt;version&gt;/&lt;plural&gt;</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">plural</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">spacetimes</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># singular name to be used as an alias on the CLI and for display</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">singular</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">spacetime</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># kind is normally the CamelCased singular type. Your resource manifests use this.</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SpaceTime</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># shortNames allow shorter string to match your resource on the CLI</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">shortNames</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">st</span><span class="w"></span>
|
||
</pre></div>
|
||
<p>You can learn more about the fields and options <a class="reference external" href="https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/">here</a>. The CRD that we defined above corresponds to the <code>CustomResource</code> given below. Once you apply the above file you will be able to see the <code>spacetime</code> custom resource on your Kubernetes/OpenShift cluster.</p>
|
||
<div class="highlight"><pre><span></span><span class="c1"># file: spacetime-cr.yaml</span><span class="w"></span>
|
||
<span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">spacetimes.example.com/v1alpha1</span><span class="w"></span>
|
||
<span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SpaceTime</span><span class="w"></span>
|
||
<span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">spacetime-cr</span><span class="w"></span>
|
||
<span class="nt">spec</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">message</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Hello</span><span class="nv"> </span><span class="s">from</span><span class="nv"> </span><span class="s">space!&quot;</span><span class="w"></span>
|
||
</pre></div>
|
||
<p>Apply them using the following commands:</p>
|
||
<div class="highlight"><pre><span></span>kubectl apply -f spacetime-crd.yaml
|
||
kubectl apply -f spacetime-cr.yaml
|
||
</pre></div>
|
||
<ol class="arabic simple" start="2">
|
||
<li>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</code> 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.</li>
|
||
</ol>
|
||
<div class="highlight"><pre><span></span>mkdir -p pkg/api/spacetime/v1alpha1
|
||
touch pkg/api/spacetime/v1alpha1/<span class="o">{</span>spacetime_types,register,doc<span class="o">}</span>.go pkg/api/spacetime/register.go
|
||
</pre></div>
|
||
<p>Add the following content to the corresponding files.</p>
|
||
<div class="highlight"><pre><span></span><span class="c1">// file: /pkg/api/spacetime/v1alpha1/spacetime_types.go</span><span class="w"></span>
|
||
<span class="kn">package</span><span class="w"> </span><span class="nx">v1alpha1</span><span class="w"></span>
|
||
|
||
<span class="kn">import</span><span class="w"> </span><span class="p">(</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nx">metav1</span><span class="w"> </span><span class="s">&quot;k8s.io/apimachinery/pkg/apis/meta/v1&quot;</span><span class="w"></span>
|
||
<span class="p">)</span><span class="w"></span>
|
||
|
||
<span class="kd">type</span><span class="w"> </span><span class="nx">SpaceTime</span><span class="w"> </span><span class="kd">struct</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nx">metav1</span><span class="p">.</span><span class="nx">TypeMeta</span><span class="w"> </span><span class="s">`json:&quot;,inline&quot;`</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nx">metav1</span><span class="p">.</span><span class="nx">ObjectMeta</span><span class="w"> </span><span class="s">`json:&quot;metadata,omitempty&quot;`</span><span class="w"></span>
|
||
|
||
<span class="w"> </span><span class="nx">Spec</span><span class="w"> </span><span class="nx">SpaceTimeSpec</span><span class="w"> </span><span class="s">`json:&quot;spec&quot;`</span><span class="w"></span>
|
||
<span class="p">}</span><span class="w"></span>
|
||
|
||
<span class="kd">type</span><span class="w"> </span><span class="nx">SpaceTimeSpec</span><span class="w"> </span><span class="kd">struct</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nx">Message</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="s">`json:&quot;message&quot;`</span><span class="w"></span>
|
||
<span class="p">}</span><span class="w"></span>
|
||
|
||
<span class="kd">type</span><span class="w"> </span><span class="nx">SpaceTimeList</span><span class="w"> </span><span class="kd">struct</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nx">metav1</span><span class="p">.</span><span class="nx">TypeMeta</span><span class="w"> </span><span class="s">`json:&quot;,inline&quot;`</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nx">metav1</span><span class="p">.</span><span class="nx">ListMeta</span><span class="w"> </span><span class="s">`json:&quot;metadata&quot;`</span><span class="w"></span>
|
||
|
||
<span class="w"> </span><span class="nx">Items</span><span class="w"> </span><span class="p">[]</span><span class="nx">SpaceTime</span><span class="w"> </span><span class="s">`json:&quot;items&quot;`</span><span class="w"></span>
|
||
<span class="p">}</span><span class="w"></span>
|
||
</pre></div>
|
||
<p><strong>To be Continued</strong></p>
|
||
</div>
|
||
</content><category term="development"></category><category term="kubernetes"></category><category term="redhat"></category><category term="docker"></category><category term="golang"></category><category term="tekton"></category><category term="openshift"></category><category term="intern"></category></entry><entry><title>My internship at Red Hat</title><link href="https://avinal.space/posts/development/i-am-loving-it-redhat.html" rel="alternate"></link><published>2022-02-25T20:47:00+05:30</published><updated>2022-02-25T20:47:00+05:30</updated><author><name>Avinal</name></author><id>tag:avinal.space,2022-02-25:/posts/development/i-am-loving-it-redhat.html</id><summary type="html"><p class="first last">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.</p>
|
||
</summary><content type="html"><p>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.</p>
|
||
<p>On the first day of my internship, I met two amazing teammates <a class="reference external" href="https://github.com/">Saytam</a> and <a class="reference external" href="https://github.com/">Utkarsh</a>. We were also introduced to a Senior Software Engineer <a class="reference external" href="https://github.com">Piyush Garg</a> 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 <strong>DevTools Developer/Engineer</strong> do?</p>
|
||
<div class="section" id="what-does-a-devtools-developer-engineer-do">
|
||
<h2>What does a DevTools Developer/Engineer do?</h2>
|
||
<p>From <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Glossary/Developer_Tools">MDN Web Docs</a> <strong>Developer tools (or &quot;development tools&quot; or short &quot;DevTools&quot;) are programs that allow a developer to create, test, and debug software.</strong> At RedHat, a lot of open source developer tools of industry standards are developed. There are many, OpenShift, Tekton, CodeReady containers, and many more.</p>
|
||
</div>
|
||
<div class="section" id="learning-on-the-golang-logo">
|
||
<h2>Learning on the <img alt="golang_logo" class="align-top" src="/images/golang.png" style="width: 2.5em;" /></h2>
|
||
<p>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.</p>
|
||
<div class="section" id="golang-1">
|
||
<h3><a class="reference external" href="https://go.dev/">Golang</a></h3>
|
||
<img alt="Gopher on the ladder" class="float-md-right rounded ml-3" src="/images/goladder.png" style="height: 20em;" />
|
||
<p>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.</p>
|
||
<ul class="simple">
|
||
<li><a class="reference external" href="https://go.dev/doc/">Official Go Documentation</a> - <em>Start from here</em></li>
|
||
<li><a class="reference external" href="https://gobyexample.com/">Go by Example</a> - <em>bite-size examples for most of the golang features</em></li>
|
||
<li><a class="reference external" href="https://golangbot.com/learn-golang-series/">Golang tutorial series - GOLANGBOT.COM</a> - <em>in-depth tutorial of golang</em></li>
|
||
<li><a class="reference external" href="https://go.dev/doc/effective_go">Effective Go</a> - <em>writing good golang programs</em></li>
|
||
<li><a class="reference external" href="https://go.dev/play/">The Go Playground</a> - <em>official online golang ide</em></li>
|
||
<li><a class="reference external" href="https://www.gopl.io/">The Go Programming Language - Book</a> <em>for learning advanced level golang</em></li>
|
||
<li><a class="reference external" href="https://youtu.be/yyUHQIec83I">Golang Tutorial for Beginners | Full Go Course - TechWorld with Nana</a> <em>if you prefer video tutorials, I don't :)</em></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="docker-1">
|
||
<h3><a class="reference external" href="https://www.docker.com/">Docker</a></h3>
|
||
<p>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.</p>
|
||
<img alt="The Docker Architecture" class="float-md-right img-fluid my-3" src="/images/docker-architecture.png" />
|
||
<ul class="simple">
|
||
<li><a class="reference external" href="https://www.katacoda.com/courses/docker">Docker and Containers - Katacoda</a> <em>interactive lessons on docker and containers</em></li>
|
||
<li><a class="reference external" href="https://docker-curriculum.com/">Docker for beginners</a></li>
|
||
<li><a class="reference external" href="https://youtu.be/3c-iBn73dDE">Docker Tutorial for Beginners | TechWorld with Nana</a> <em>video tutorial</em></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="kubernetes-1">
|
||
<h3><a class="reference external" href="https://kubernetes.io/">Kubernetes</a></h3>
|
||
<img alt="Kubernetes tech" class="float-md-left border mr-3" src="/images/kubernetes-meme.png" style="width: 200px;" />
|
||
<p><strong>Kubernetes</strong> 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.</p>
|
||
<ul class="simple">
|
||
<li><a class="reference external" href="https://www.katacoda.com/courses/kubernetes">Learn Kubernetes - Katacoda</a> <em>interactive lessons with kubernetes</em></li>
|
||
<li><a class="reference external" href="https://kubebyexample.com/">kube by example</a> <em>learn by doing</em></li>
|
||
<li><a class="reference external" href="https://youtu.be/X48VuDVv0do">Kubernetes Tutorial for Beginners</a> <em>video tutorial</em></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="not-so-minimal-tekton-server">
|
||
<h2><em>Not so Minimal</em> Tekton Server</h2>
|
||
<p>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.</p>
|
||
<p>The application was called <strong>Minimal Tekton Server</strong>. It is a set of three different applications, i.e a server, a CLI, and a dashboard. In short, this application is supposed to <em>listen to custom resources being created and then transfer the request to Tekton API to create the corresponding resource on the OpenShift/Kubernetes cluster.</em></p>
|
||
<p>So are you interested in how it went? Please follow up with my <a class="reference external" href="https://avinal.space/posts/development/lovely-dangerous-things-redhat.html">next blog</a>.</p>
|
||
</div>
|
||
</content><category term="development"></category><category term="kubernetes"></category><category term="redhat"></category><category term="docker"></category><category term="golang"></category><category term="tekton"></category><category term="openshift"></category><category term="intern"></category></entry><entry><title>reStructuredText in GitHub</title><link href="https://avinal.space/posts/development/rst-guide.html" rel="alternate"></link><published>2021-02-14T22:47:00+05:30</published><updated>2021-02-14T22:47:00+05:30</updated><author><name>Avinal</name></author><id>tag:avinal.space,2021-02-14:/posts/development/rst-guide.html</id><summary type="html"><p class="first last">reStructuredText syntax</p>
|
||
</summary><content type="html"><ul>
|
||
<li><p class="first">Headers</p>
|
||
<div class="highlight"><pre><span></span><span class="gh">Top Title</span>
|
||
<span class="gh">=========</span>
|
||
|
||
<span class="gh">Sub Title</span>
|
||
<span class="gh">---------</span>
|
||
|
||
<span class="gh">Sub Sub Title</span>
|
||
<span class="gh">^^^^^^^^^^^^^</span>
|
||
</pre></div>
|
||
</li>
|
||
<li><p class="first">Images</p>
|
||
<ul>
|
||
<li><p class="first">Direct</p>
|
||
<div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">figure</span><span class="p">::</span> image-path-or-url
|
||
<span class="nc">:align:</span> center
|
||
<span class="nc">:target:</span> link-to-go-when-image-is-clicked
|
||
<span class="nc">:alt:</span> alternative-text-if-any
|
||
</pre></div>
|
||
</li>
|
||
<li><p class="first">Indirect</p>
|
||
<div class="highlight"><pre><span></span><span class="p">..</span> <span class="nt">|substitution|</span> <span class="ow">image</span><span class="p">::</span> image-path-or-url
|
||
<span class="nc">:target:</span> link-to-go-when-image-is-clicked
|
||
</pre></div>
|
||
<p>You can use <code>|substitution|</code> where you want to put your image.</p>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p class="first">Links</p>
|
||
<div class="highlight"><pre><span></span><span class="s">`Link Text </span><span class="si">&lt;link-itself&gt;</span><span class="s">`__</span>
|
||
</pre></div>
|
||
</li>
|
||
<li><p class="first">Lists</p>
|
||
<div class="highlight"><pre><span></span><span class="m">-</span> item 1
|
||
<span class="m">-</span> item 2
|
||
|
||
<span class="m">*</span> item 1
|
||
<span class="m">*</span> itme 2
|
||
|
||
<span class="m">#.</span> item 1
|
||
<span class="m">#.</span> item 2
|
||
|
||
<span class="m">1.</span> item 1
|
||
<span class="m">2.</span> item 2
|
||
</pre></div>
|
||
<p>First two lists are unordered next two are ordered.</p>
|
||
</li>
|
||
<li><p class="first">Code</p>
|
||
<ul>
|
||
<li><p class="first">Inline</p>
|
||
<div class="highlight"><pre><span></span><span class="na">:code:</span><span class="nv">`your-code`</span>
|
||
</pre></div>
|
||
</li>
|
||
<li><p class="first">Code block</p>
|
||
<div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">code-block</span><span class="p">::</span> <span class="k">language(optional)</span>
|
||
|
||
<span class="s"> Your code</span>
|
||
<span class="s"> in multiple lines. You may enable line numbers too.</span>
|
||
</pre></div>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p class="first">Tables</p>
|
||
<div class="highlight"><pre><span></span>+----------------+----------------+
|
||
<span class="o">|</span> Header Cell | Header Cell |
|
||
+================+================+
|
||
<span class="o">|</span> Data cell | Data Cell |
|
||
+----------------+----------------+
|
||
<span class="o">|</span> Header Cell | Header Cell |
|
||
+----------------+----------------+
|
||
</pre></div>
|
||
</li>
|
||
<li><p class="first">Raw HTML block</p>
|
||
<div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">raw</span><span class="p">::</span> html
|
||
|
||
&lt;put&gt;
|
||
your html code here
|
||
&lt;/put&gt;
|
||
</pre></div>
|
||
</li>
|
||
<li><p class="first">Notes, warnings</p>
|
||
<div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">note</span><span class="p">::</span>
|
||
|
||
Put your note here.
|
||
|
||
<span class="p">..</span> <span class="ow">warning</span><span class="p">::</span>
|
||
|
||
Put your warning here.
|
||
|
||
<span class="p">..</span> <span class="ow">important</span><span class="p">::</span>
|
||
|
||
Put instructions here.
|
||
|
||
<span class="p">..</span> <span class="ow">admonition</span><span class="p">::</span> custom-text
|
||
|
||
Custom description here.
|
||
</pre></div>
|
||
</li>
|
||
</ul>
|
||
<p>These all are supported by GitHub very well. For more exhautive list specific to Sphinx see <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html">this</a> link.</p>
|
||
<div class="section" id="tips">
|
||
<h2>Tips</h2>
|
||
<ul class="simple">
|
||
<li>There must be a blank line before and after any directive. Such as after title or code block, tables etc.</li>
|
||
<li>The options and content of a directives must be 1 tab indented to the directives.</li>
|
||
</ul>
|
||
</div>
|
||
</content><category term="development"></category><category term="rst"></category><category term="github"></category></entry><entry><title>How I implemented WakaTime embeddable Coding Graph GHA?</title><link href="https://avinal.space/posts/development/wakatime-readme.html" rel="alternate"></link><published>2021-02-02T21:47:00+05:30</published><updated>2021-02-02T21:47:00+05:30</updated><author><name>Avinal</name></author><id>tag:avinal.space,2021-02-02:/posts/development/wakatime-readme.html</id><summary type="html"><p class="first last">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.</p>
|
||
</summary><content type="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><div class="section" id="implementation-details">
|
||
<h2>Implementation Details</h2>
|
||
<p>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.</p>
|
||
<ol class="arabic simple">
|
||
<li><a class="reference external" href="https://github.com/avinal/Profile-Readme-WakaTime/blob/master/main.py">main.py</a> python script. This script contains many procedures.</li>
|
||
</ol>
|
||
<ul>
|
||
<li><p class="first"><a class="reference external" href="https://github.com/avinal/Profile-Readme-WakaTime/blob/master/main.py#L52">Getting JSON data file via WakaTime API</a></p>
|
||
<blockquote>
|
||
<div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">get_stats</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">:</span>
|
||
<span class="o">...</span>
|
||
<span class="k">return</span> <span class="n">data_list</span>
|
||
</pre></div>
|
||
</blockquote>
|
||
<p>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.</p>
|
||
</li>
|
||
<li><p class="first"><a class="reference external" href="https://github.com/avinal/Profile-Readme-WakaTime/blob/master/main.py#L13">Setting the Timeline</a></p>
|
||
<blockquote>
|
||
<div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">this_week</span><span class="p">(</span><span class="n">dates</span><span class="p">:</span> <span class="nb">list</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
|
||
<span class="o">...</span>
|
||
<span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;Coding Activity During: </span><span class="si">{</span><span class="n">week_start</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">%d</span><span class="s1"> %B, %Y&#39;</span><span class="p">)</span><span class="si">}</span><span class="s2"> to </span><span class="si">{</span><span class="n">week_end</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">%d</span><span class="s1"> %B, %Y&#39;</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
|
||
</pre></div>
|
||
</blockquote>
|
||
<p>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 :</p>
|
||
<blockquote>
|
||
<div class="highlight"><pre><span></span><span class="err">da</span><span class="kc">te</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;YYYY-MM-DDTHH:MM:SSZ&quot;</span><span class="w"></span>
|
||
</pre></div>
|
||
</blockquote>
|
||
<p>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.</p>
|
||
</li>
|
||
<li><p class="first"><a class="reference external" href="https://github.com/avinal/Profile-Readme-WakaTime/blob/master/main.py#L21">Creating a bar graph</a></p>
|
||
<blockquote>
|
||
<div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">make_graph</span><span class="p">(</span><span class="n">data</span><span class="p">:</span> <span class="nb">list</span><span class="p">):</span>
|
||
<span class="o">...</span>
|
||
<span class="n">savefig</span><span class="p">(</span><span class="o">...</span><span class="p">)</span>
|
||
</pre></div>
|
||
</blockquote>
|
||
<p>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 <cite>matplotlib</cite> 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 <cite>colors.json</cite>. 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.</p>
|
||
</li>
|
||
</ul>
|
||
<ol class="arabic" start="2">
|
||
<li><p class="first"><a class="reference external" href="https://github.com/avinal/Profile-Readme-WakaTime/blob/master/entrypoint.sh">entrypoint.py</a> 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 <strong>github-actions</strong> bot email.</p>
|
||
<blockquote>
|
||
<div class="highlight"><pre><span></span>remote_repo-<span class="s2">&quot;https://</span><span class="si">${</span><span class="nv">GITHUB_ACTOR</span><span class="si">}</span><span class="s2">:</span><span class="si">${</span><span class="nv">INPUT_GITHUB_TOKEN</span><span class="si">}</span><span class="s2">@github.com/</span><span class="si">${</span><span class="nv">GITHUB_REPOSITORY</span><span class="si">}</span><span class="s2">.git&quot;</span>
|
||
git config user.email <span class="s2">&quot;41898282+github-actions[bot]@users.noreply.github.com&quot;</span>
|
||
git config user.name <span class="s2">&quot;GitHub Actions&quot;</span>
|
||
</pre></div>
|
||
</blockquote>
|
||
</li>
|
||
</ol>
|
||
<blockquote>
|
||
<p><code>41898282</code> is the id assigned to the github-actions bot. Don't ask where I found them 🙂.</p>
|
||
<p>Another problem was to separate repository name from combined <em>username/repository-name</em> provided by <cite>${GITHUB_REPOSITORY}</cite>. GitHub doesn't provides a direct way to get just the repo name. We used <em>Internal Field Separator</em>. It returns an array and works similar to <code>split()</code> command in Python and Java.</p>
|
||
<blockquote>
|
||
<div class="highlight"><pre><span></span><span class="c1"># &#39;/&#39; is the seperator</span>
|
||
IFS-<span class="s1">&#39;/&#39;</span> <span class="nb">read</span> -ra reponame <span class="o">&lt;&lt;&lt;</span> <span class="s2">&quot;</span><span class="si">${</span><span class="nv">GITHUB_REPOSITORY</span><span class="si">}</span><span class="s2">&quot;</span>
|
||
<span class="c1"># returned {username, repository}</span>
|
||
repository-<span class="s2">&quot;</span><span class="si">${</span><span class="nv">reponame</span><span class="p">[1]</span><span class="si">}</span><span class="s2">&quot;</span>
|
||
</pre></div>
|
||
</blockquote>
|
||
</blockquote>
|
||
<p>After that, all other commands are pretty straight. Commit the added files and push them.</p>
|
||
<ol class="arabic simple" start="3">
|
||
<li><a class="reference external" href="https://github.com/avinal/Profile-Readme-WakaTime/blob/master/Dockerfile">Dockerfile</a> <strong>IMPORTANT</strong> It took a lot of time to reach this state 🥱. This is where all the magic happens. I am running <cite>ubuntu:latest</cite> inside the container. I first update the distribution. Then install the required python packages. Lastly, I invoke the python script and shell script.</li>
|
||
</ol>
|
||
<p>There was an almost impossible problem, I searched hundreds of posts that <em>how can I access the generated files inside Docker container</em>, 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.</p>
|
||
<div class="highlight"><pre><span></span><span class="k">CMD</span><span class="w"> </span>python3 /main.py <span class="o">&amp;&amp;</span> /entrypoint.sh
|
||
</pre></div>
|
||
<p>This part is the smallest yet took the most time and tries while developing this action.</p>
|
||
</div>
|
||
<div class="section" id="how-to-use-this-github-actions">
|
||
<h2>How to use this GitHub Actions?</h2>
|
||
<ol class="arabic">
|
||
<li><p class="first">First get your WakaTime API Key. You can get it from your [WakaTime](<a class="reference external" href="https://wakatime.com">https://wakatime.com</a>) account settings.</p>
|
||
</li>
|
||
<li><p class="first">Save WakaTime API Key to Repository Secret. Find that by clicking the Settings tab. Keep the name of the secret as <strong>WAKATIME_API_KEY</strong>.</p>
|
||
</li>
|
||
<li><p class="first">Add the following line in your README.md of your repo.</p>
|
||
<blockquote>
|
||
<div class="highlight"><pre><span></span><span class="p">&lt;</span><span class="nt">img</span> <span class="na">src-</span><span class="err">&quot;</span><span class="na">https:</span><span class="err">//</span><span class="na">github</span><span class="err">.</span><span class="na">com</span><span class="err">/&lt;</span><span class="na">username</span><span class="p">&gt;</span>/<span class="p">&lt;</span><span class="nt">repository-name</span><span class="p">&gt;</span>/blob/<span class="p">&lt;</span><span class="nt">branch-name</span><span class="p">&gt;</span>/images/stat.svg&quot; alt-&quot;Alternative Text&quot;/&gt;
|
||
Example: <span class="p">&lt;</span><span class="nt">img</span> <span class="na">src-</span><span class="err">&quot;</span><span class="na">https:</span><span class="err">//</span><span class="na">github</span><span class="err">.</span><span class="na">com</span><span class="err">/</span><span class="na">avinal</span><span class="err">/</span><span class="na">avinal</span><span class="err">/</span><span class="na">blob</span><span class="err">/</span><span class="na">main</span><span class="err">/</span><span class="na">images</span><span class="err">/</span><span class="na">stat</span><span class="err">.</span><span class="na">svg</span><span class="err">&quot;</span> <span class="na">alt-</span><span class="err">&quot;</span><span class="na">Avinal</span> <span class="na">WakaTime</span> <span class="na">Activity</span><span class="err">&quot;</span><span class="p">/&gt;</span>
|
||
</pre></div>
|
||
</blockquote>
|
||
</li>
|
||
</ol>
|
||
<blockquote>
|
||
You can use this method to embed in web pages too. <strong>Do not use the markdown method of inserting images. It does not work sometimes.</strong></blockquote>
|
||
<ol class="arabic" start="4">
|
||
<li><p class="first">Click the <strong>Action</strong> tab and <strong>choose to set up a workflow yourself</strong>.</p>
|
||
</li>
|
||
<li><p class="first">Copy the following code into the opened file, you can search for <strong>WakaTime Stat</strong> in the marketplace tab for assistance.</p>
|
||
<blockquote>
|
||
<div class="highlight"><pre><span></span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">WakaTime status update</span><span class="w"></span>
|
||
|
||
<span class="nt">on</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">schedule</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># Runs at 12 am &#39;0 0 * * *&#39; UTC</span><span class="w"></span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">cron</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;1</span><span class="nv"> </span><span class="s">0</span><span class="nv"> </span><span class="s">*</span><span class="nv"> </span><span class="s">*</span><span class="nv"> </span><span class="s">*&quot;</span><span class="w"></span>
|
||
|
||
<span class="nt">jobs</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">update-readme</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Update the WakaTime Stat</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">runs-on</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ubuntu-latest</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">steps</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># Use avinal/Profile-Readme-WakaTime@&lt;latest-release-tag&gt; for latest stable release</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># Do not change the line below except the word master with tag number maybe</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># If you have forked this project you can use &lt;username&gt;/Profile-Readme-WakaTime@master instead</span><span class="w"></span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">avinal/Profile-Readme-WakaTime@master</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">with</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># WakaTime API key stored in secrets, do not directly paste it here</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">WAKATIME_API_KEY</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${{ secrets.WAKATIME_API_KEY }}</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># Automatic github token</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">GITHUB_TOKEN</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${{ github.token }}</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># Branch - newer GitHub repositories have &quot;main&quot; as default branch, change to main in that case, default is master</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">BRANCH</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;master&quot;</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># Manual Commit messages - write your own messages here</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">COMMIT_MSG</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Automated</span><span class="nv"> </span><span class="s">Coding</span><span class="nv"> </span><span class="s">Activity</span><span class="nv"> </span><span class="s">Update</span><span class="nv"> </span><span class="s">:alien:&quot;</span><span class="w"></span>
|
||
</pre></div>
|
||
</blockquote>
|
||
</li>
|
||
<li><p class="first">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 <cite>on:</cite> to run with every push. Search for 12 AM UTC to find the equivalent time in your time zone.</p>
|
||
<blockquote>
|
||
<div class="highlight"><pre><span></span><span class="nt">on</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">push</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">branches</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="w"> </span><span class="nv">master</span><span class="w"> </span><span class="p p-Indicator">]</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">schedule</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">cron</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;1</span><span class="nv"> </span><span class="s">0</span><span class="nv"> </span><span class="s">*</span><span class="nv"> </span><span class="s">*</span><span class="nv"> </span><span class="s">*&#39;</span><span class="w"></span>
|
||
</pre></div>
|
||
</blockquote>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
<div class="section" id="my-coding-activity">
|
||
<h2>My Coding Activity</h2>
|
||
<img class="img-fluid" src="https://raw.githubusercontent.com/avinal/avinal/main/images/stat.svg"></div>
|
||
</content><category term="development"></category><category term="wakatime"></category><category term="github-action"></category><category term="coding"></category></entry><entry><title>How I Created This Blog?</title><link href="https://avinal.space/posts/development/twilight-blog.html" rel="alternate"></link><published>2021-01-26T16:47:00+05:30</published><updated>2021-01-26T16:47:00+05:30</updated><author><name>Avinal</name></author><id>tag:avinal.space,2021-01-26:/posts/development/twilight-blog.html</id><summary type="html"><p class="first last">As you would have guessed by now, this blog is created using one such awesome SSG named <strong>Pelican</strong>. Pelican is simple, customizable and offers lots of themes and plugins. Pelican is python based SSG and is available through <tt class="docutils literal">pip</tt>.</p>
|
||
</summary><content type="html"><p><span class="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></span></p>
|
||
<p>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 title="Static Site Generator">SSGs</abbr> to the rescue. <strong>Static Site Generators</strong> 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, <a class="reference external" href="https://jekyllrb.com/">Jekyll</a>, <a class="reference external" href="https://blog.getpelican.com/">Pelican</a> and more complex ones like <a class="reference external" href="https://www.gatsbyjs.com/">Gatsby</a>, <a class="reference external" href="https://gohugo.io/">Hugo</a> .</p>
|
||
<p>As you would have guessed by now, this blog is created using one such awesome SSG named <strong>Pelican</strong>. Pelican is simple, customizable and offers lots of <a class="reference external" href="http://www.pelicanthemes.com/">themes</a> and <a class="reference external" href="https://github.com/getpelican/pelican-plugins">plugins</a>. Pelican is python based SSG and is available through <code>pip</code>.</p>
|
||
<div class="highlight"><pre><span></span><span class="c1"># for reStructuredText only (recommended)</span>
|
||
python -m pip install pelican
|
||
|
||
<span class="c1"># for markdown and reStructuredText both</span>
|
||
python -m pip install <span class="s2">&quot;pelican[markdown]&quot;</span>
|
||
</pre></div>
|
||
<p>You can start a pelican project by typing following command. It will create a basic template and build configurations.</p>
|
||
<div class="highlight"><pre><span></span>pelican-quickstart
|
||
|
||
<span class="c1"># output</span>
|
||
yourproject/
|
||
├── content <span class="c1"># Put your content here</span>
|
||
│ └── <span class="o">(</span>pages<span class="o">)</span>
|
||
├── output <span class="c1"># Output files</span>
|
||
├── tasks.py
|
||
├── Makefile <span class="c1"># Makefile to run build and publish command</span>
|
||
├── pelicanconf.py <span class="c1"># Main settings file</span>
|
||
└── publishconf.py <span class="c1"># Settings to use when ready to publish</span>
|
||
</pre></div>
|
||
<p>Next step is to choose themes. As I said earlier there are lots of <a class="reference external" href="http://www.pelicanthemes.com/">themes</a> . And it is easy to create your own theme. Check <a class="reference external" href="https://docs.getpelican.com/en/latest/themes.html">here</a> to create your own theme. My choice of theme was <a class="reference external" href="https://nairobilug.github.io/pelican-alchemy/">pelican-alchemy</a> . This is a simple and great theme. Installing and removing themes in pelican is very easy.</p>
|
||
<div class="highlight"><pre><span></span><span class="c1"># list all installed themes</span>
|
||
pelican-themes -l
|
||
<span class="c1"># output</span>
|
||
simple
|
||
alchemy
|
||
notmyidea
|
||
|
||
<span class="c1"># install new theme</span>
|
||
pelican-themes -i theme-path
|
||
|
||
<span class="c1"># remove a theme</span>
|
||
pelican-themes -r theme-name
|
||
</pre></div>
|
||
<p>To use a particular theme, set the <code>THEME</code> variable in the <strong>pelicanconf.py</strong> file.</p>
|
||
<div class="highlight"><pre><span></span><span class="n">THEME</span> <span class="o">=</span> <span class="s1">&#39;alchemy&#39;</span>
|
||
</pre></div>
|
||
<p>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.</p>
|
||
<div class="highlight"><pre><span></span><span class="n">THEME</span> <span class="o">=</span> <span class="s1">&#39;path-to-theme-directory&#39;</span>
|
||
</pre></div>
|
||
<p>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.</p>
|
||
<div class="highlight"><pre><span></span><span class="c1"># build your website</span>
|
||
make html
|
||
<span class="c1"># output</span>
|
||
<span class="s2">&quot;pelican&quot;</span> <span class="s2">&quot;/mnt/z/my_git/avinal.github.io/content&quot;</span> -o <span class="s2">&quot;/mnt/z/my_git/avinal.github.io/output&quot;</span> -s <span class="s2">&quot;/mnt/z/my_git/avinal.github.io/pelicanconf.py&quot;</span>
|
||
Done: Processed <span class="m">6</span> articles, <span class="m">0</span> drafts, <span class="m">1</span> page, <span class="m">0</span> hidden pages and <span class="m">0</span> draft pages <span class="k">in</span> <span class="m">2</span>.43 seconds.
|
||
|
||
<span class="c1"># build and test/serve on localhost</span>
|
||
make serve
|
||
<span class="c1"># output</span>
|
||
<span class="s2">&quot;pelican&quot;</span> -l <span class="s2">&quot;/mnt/z/my_git/avinal.github.io/content&quot;</span> -o <span class="s2">&quot;/mnt/z/my_git/avinal.github.io/output&quot;</span> -s <span class="s2">&quot;/mnt/z/my_git/avinal.github.io/pelicanconf.py&quot;</span>
|
||
|
||
Serving site at: <span class="m">127</span>.0.0.1:8000 - Tap CTRL-C to stop
|
||
</pre></div>
|
||
<p>Now open your browser and open <a class="reference external" href="127.0.0.1:8000">127.0.0.1:8000</a> or <a class="reference external" href="localhost:8000">localhost:8000</a>. You should be able to see your new blog. Stop local server using <code>CTRL+C</code>. 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 <a class="reference external" href="https://pages.github.com/">this</a> help for instructions on that. Before pushing to GitHub add this little script to your project.</p>
|
||
<div class="highlight"><pre><span></span><span class="ch">#! /bin/bash</span>
|
||
<span class="c1">## file: publi.sh</span>
|
||
|
||
<span class="c1"># install tools</span>
|
||
sudo apt-get install -y git make python3 python3-pip python3-setuptools python3-wheel
|
||
|
||
<span class="c1"># setup github config</span>
|
||
git config user.email <span class="s2">&quot;your-email&quot;</span>
|
||
git config user.name <span class="s2">&quot;your-username&quot;</span>
|
||
|
||
<span class="c1"># install dependencies</span>
|
||
sudo pip3 install -r requirements.txt
|
||
|
||
<span class="c1"># pelican commands - install theme put your theme in themes directory</span>
|
||
pelican-themes --install themes/theme-name
|
||
|
||
<span class="c1"># publish to github pages</span>
|
||
ghp-import -m <span class="s2">&quot;Generate Pelican site&quot;</span> -b gh-pages output
|
||
git push -f origin gh-pages
|
||
</pre></div>
|
||
<p>Now once your project is on GitHub, go to the <strong>Actions</strong> tab and click on <em>set up a workflow yourself</em> and paste the following code into the file and commit it.</p>
|
||
<div class="highlight"><pre><span></span><span class="c1"># file: publish.yml</span><span class="w"></span>
|
||
<span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Publish Blog</span><span class="w"></span>
|
||
<span class="nt">on</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">push</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">branches</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="w"> </span><span class="nv">main</span><span class="w"> </span><span class="p p-Indicator">]</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">pull_request</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">branches</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="w"> </span><span class="nv">main</span><span class="w"> </span><span class="p p-Indicator">]</span><span class="w"></span>
|
||
|
||
<span class="nt">jobs</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">build</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">runs-on</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ubuntu-latest</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">steps</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">actions/checkout@v2</span><span class="w"></span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">set up permissions</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">run</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">chmod +x publi.sh</span><span class="w"></span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Run a multi-line script</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">run</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./publi.sh</span><span class="w"></span>
|
||
</pre></div>
|
||
<p>If you have done everything correctly then go to <em>https://username.github.io</em> 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.</p>
|
||
<p><span class="html-raw"><h2 style=font-family:Exodar;font-weight:lighter;">But My Blog is Special 🥰</h2></span></p>
|
||
<p>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 <span class="html-raw"><a href="mailto:avinal.xlvii@gmail.com" class="fa fa-envelope" style="text-decoration: none;"></a></span> or starting a discussion on <span class="html-raw"><a href="https://github.com/avinal/avinal/discussions/2" class="fab fa-github" style="text-decoration: none;"></a></span>.</p>
|
||
<ul class="simple">
|
||
<li><a class="reference external" href="https://blog.getpelican.com/">Pelican Blog</a></li>
|
||
<li><a class="reference external" href="https://docs.getpelican.com/en/latest/">Pelican Docs</a></li>
|
||
<li><a class="reference external" href="http://www.pelicanthemes.com/">Pelican Themes</a></li>
|
||
<li><a class="reference external" href="https://github.com/nairobilug/pelican-alchemy">Pelican Alchemy Theme</a></li>
|
||
<li><a class="reference external" href="https://codepen.io/saransh/pen/BKJun">Parallax Star background in CSS</a></li>
|
||
<li><a class="reference external" href="https://codepen.io/kowlor/pen/ZYYQoy">Solar System animation</a></li>
|
||
<li><span class="html-raw"><a href="https://www.dafont.com/exodar.font" style="font-family: Exodar;font-weight: lighter;text-decoration: none;">EXODAR Font</a></span></li>
|
||
<li><a class="reference external" href="https://fonts.google.com/specimen/Overpass+Mono">Overpass Mono</a></li>
|
||
<li><a class="reference external" href="https://fontawesome.com/how-to-use/on-the-web/setup/hosting-font-awesome-yourself">Font Awesome</a></li>
|
||
</ul>
|
||
<p><span class="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></span></p>
|
||
<p><span class="html-raw"><p align=center>Thanks!</p></span></p>
|
||
</content><category term="development"></category><category term="blog"></category><category term="pelican"></category><category term="ssg"></category></entry><entry><title>Move WSL 2 Safely to another Drive</title><link href="https://avinal.space/posts/development/wsl1.html" rel="alternate"></link><published>2020-12-31T19:07:00+05:30</published><updated>2020-12-31T19:07:00+05:30</updated><author><name>Avinal</name></author><id>tag:avinal.space,2020-12-31:/posts/development/wsl1.html</id><summary type="html"><p class="first last">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.</p>
|
||
</summary><content type="html"><p>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.</p>
|
||
<ol class="arabic simple">
|
||
<li>Open a PowerShell <img alt="powershell" class="align-middle" src="/images/powershell.png" style="width: 5%;" /> or Command Prompt <img alt="command-line" class="align-middle" src="/images/command-line.png" style="width: 5%;" /> with <em>Admin</em> access. For this you can use <img alt="WinKey" class="align-middle" src="/images/windows10.png" style="width: 5%;" /> + X shortcut and select <strong>Windows PowerShell(Admin)</strong>.</li>
|
||
<li>Check if the WSL 2 installation you are planning to move is is currently running/stopped.</li>
|
||
</ol>
|
||
<div class="highlight"><pre><span></span><span class="nb">PS </span><span class="n">C</span><span class="p">:\</span><span class="n">Users</span><span class="p">\</span><span class="n">Avinal</span><span class="p">&gt;</span> <span class="n">wsl</span> <span class="n">-l</span> <span class="n">-v</span>
|
||
<span class="nb">PS </span><span class="n">C</span><span class="p">:\</span><span class="n">Users</span><span class="p">\</span><span class="n">Avinal</span><span class="p">&gt;</span>
|
||
<span class="n">NAME</span> <span class="n">STATE</span> <span class="n">VERSION</span>
|
||
<span class="p">*</span> <span class="n">Ubuntu</span> <span class="n">Running</span> <span class="n">2</span>
|
||
<span class="n">Kali</span> <span class="n">Stopped</span> <span class="n">2</span>
|
||
</pre></div>
|
||
<ol class="arabic simple" start="3">
|
||
<li>If its running then you must stop the particular WSL distribution. (<em>Ubuntu</em> used as example)</li>
|
||
</ol>
|
||
<div class="highlight"><pre><span></span><span class="nb">PS </span><span class="n">C</span><span class="p">:\</span><span class="n">Users</span><span class="p">\</span><span class="n">Avinal</span><span class="p">&gt;</span> <span class="n">wsl</span> <span class="n">-t</span> <span class="n">Ubuntu</span>
|
||
</pre></div>
|
||
<ol class="arabic simple" start="4">
|
||
<li>Export to some folder. (Here exporting <em>Ubuntu</em> as <em>ubuntu-ex.tar</em> to <em>Z:wsl2</em>)</li>
|
||
</ol>
|
||
<div class="highlight"><pre><span></span><span class="nb">PS </span><span class="n">C</span><span class="p">:\</span><span class="n">Users</span><span class="p">\</span><span class="n">Avinal</span><span class="p">&gt;</span> <span class="n">wsl</span> <span class="p">-</span><span class="n">-export</span> <span class="n">Ubuntu</span> <span class="s2">&quot;Z:\export\ubuntu-ex.tar&quot;</span>
|
||
</pre></div>
|
||
<ol class="arabic simple" start="5">
|
||
<li>Unregister previous WSL installation</li>
|
||
</ol>
|
||
<div class="highlight"><pre><span></span><span class="nb">PS </span><span class="n">C</span><span class="p">:\</span><span class="n">Users</span><span class="p">\</span><span class="n">Avinal</span><span class="p">&gt;</span> <span class="n">wsl</span> <span class="p">-</span><span class="n">-unregister</span> <span class="n">Ubuntu</span>
|
||
</pre></div>
|
||
<ol class="arabic simple" start="6">
|
||
<li>Create a new folder and import your WSL installation to that folder.</li>
|
||
</ol>
|
||
<div class="highlight"><pre><span></span><span class="nb">PS </span><span class="n">C</span><span class="p">:\</span><span class="n">Users</span><span class="p">\</span><span class="n">Avinal</span><span class="p">&gt;</span> <span class="nb">New-Item</span> <span class="n">-Path</span> <span class="s2">&quot;Z:\wsl2&quot;</span> <span class="n">-ItemType</span> <span class="n">Directory</span>
|
||
|
||
<span class="n">Directory</span><span class="p">:</span> <span class="n">Z</span><span class="p">:\</span>
|
||
|
||
<span class="n">Mode</span> <span class="n">LastWriteTime</span> <span class="n">Length</span> <span class="n">Name</span>
|
||
<span class="p">----</span> <span class="p">-------------</span> <span class="p">------</span> <span class="p">----</span>
|
||
<span class="n">d</span><span class="p">-----</span> <span class="n">31</span><span class="p">-</span><span class="n">12</span><span class="p">-</span><span class="n">2020</span> <span class="n">21</span><span class="p">:</span><span class="n">03</span> <span class="n">wsl2</span>
|
||
|
||
<span class="nb">PS </span><span class="n">C</span><span class="p">:\</span><span class="n">Users</span><span class="p">\</span><span class="n">Avinal</span><span class="p">&gt;</span> <span class="n">wsl</span> <span class="p">-</span><span class="n">-import</span> <span class="n">Ubuntu</span> <span class="s2">&quot;Z:\wsl2&quot;</span> <span class="s2">&quot;Z:\export\ubuntu-ex.tar&quot;</span>
|
||
</pre></div>
|
||
<ol class="arabic simple" start="7">
|
||
<li>Check after import is complete</li>
|
||
</ol>
|
||
<div class="highlight"><pre><span></span><span class="nb">PS </span><span class="n">C</span><span class="p">:\</span><span class="n">Users</span><span class="p">\</span><span class="n">Avinal</span><span class="p">&gt;</span> <span class="n">wsl</span> <span class="n">-l</span> <span class="n">-v</span>
|
||
<span class="nb">PS </span><span class="n">C</span><span class="p">:\</span><span class="n">Users</span><span class="p">\</span><span class="n">Avinal</span><span class="p">&gt;</span>
|
||
<span class="n">NAME</span> <span class="n">STATE</span> <span class="n">VERSION</span>
|
||
<span class="p">*</span> <span class="n">Ubuntu</span> <span class="n">Running</span> <span class="n">2</span>
|
||
<span class="n">Kali</span> <span class="n">Stopped</span> <span class="n">2</span>
|
||
</pre></div>
|
||
<ol class="arabic simple" start="8">
|
||
<li>Mark one of your WSL distribution as <em>(default)</em>.</li>
|
||
</ol>
|
||
<div class="highlight"><pre><span></span><span class="nb">PS </span><span class="n">C</span><span class="p">:\</span><span class="n">Users</span><span class="p">\</span><span class="n">Avinal</span><span class="p">&gt;</span> <span class="n">wsl</span> <span class="n">-s</span> <span class="n">Ubuntu</span>
|
||
</pre></div>
|
||
<ol class="arabic simple" start="9">
|
||
<li>After exporting your default user will be set as <span class="html-raw"><i style="color:red">root</i></span> , to change it to your desired username, run following command</li>
|
||
</ol>
|
||
<div class="highlight"><pre><span></span><span class="nb">PS </span><span class="n">C</span><span class="p">:\</span><span class="n">Users</span><span class="p">\</span><span class="n">Avinal</span><span class="p">&gt;</span> <span class="n">ubuntu</span> <span class="n">config</span> <span class="p">-</span><span class="n">-default-user</span> <span class="n">user_name</span>
|
||
</pre></div>
|
||
<ol class="arabic simple" start="10">
|
||
<li>Finally run <code>wsl</code> and you have successfully moved your WSL 2 installation to another drive.</li>
|
||
</ol>
|
||
</content><category term="development"></category><category term="wsl"></category><category term="wsl2"></category></entry><entry><title>Create the VLC User Documentation for one Mobile Port(Android)</title><link href="https://avinal.space/posts/development/vlc-gsod-report.html" rel="alternate"></link><published>2020-12-01T23:47:00+05:30</published><updated>2020-12-31T23:19:00+05:30</updated><author><name>Avinal</name></author><id>tag:avinal.space,2020-12-01:/posts/development/vlc-gsod-report.html</id><summary type="html"><p class="first last">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.</p>
|
||
</summary><content type="html"><div class="section" id="overview">
|
||
<h2>OVERVIEW</h2>
|
||
<p>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.</p>
|
||
<p>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.</p>
|
||
</div>
|
||
<div class="section" id="project-goals">
|
||
<h2>PROJECT GOALS</h2>
|
||
<ul class="simple">
|
||
<li>Propose a new structure for documentation e.g. Chapter Separation, Sections etc</li>
|
||
<li>Proper balance between technical and non-technical descriptions to serve all kinds of users.</li>
|
||
<li>Adequate amount of screenshots in each section and other supporting media to make documentation more appealing.</li>
|
||
<li>Optimized for all Screen Sizes. Especially for Mobile Devices.</li>
|
||
<li>Ease of navigation</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="community-bonding">
|
||
<h2>COMMUNITY BONDING</h2>
|
||
<p>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.</p>
|
||
<p>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.</p>
|
||
<p>Nicolas Pomepuy, who is the lead developer of VLC for Android was assigned as my primary mentor and Simon Latapie as secondary mentor.</p>
|
||
</div>
|
||
<div class="section" id="documentation-development-phase">
|
||
<h2>DOCUMENTATION DEVELOPMENT PHASE</h2>
|
||
<p>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.</p>
|
||
<p>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.</p>
|
||
<p>Work Done</p>
|
||
<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><p>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</p>
|
||
<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></div>
|
||
<div class="section" id="challenges">
|
||
<h2>CHALLENGES</h2>
|
||
<p>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.</p>
|
||
</div>
|
||
<div class="section" id="thanks">
|
||
<h2>THANKS</h2>
|
||
<p>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.</p>
|
||
</div>
|
||
</content><category term="development"></category><category term="vlc"></category><category term="gsod"></category><category term="gsod2020"></category></entry></feed> |