pulsar #291

Merged
fede merged 1 commits from pulsar into main 2023-11-05 13:56:00 +01:00
54 changed files with 40 additions and 43 deletions
Showing only changes of commit 0e327744c9 - Show all commits

View File

@ -24,21 +24,21 @@ The procedure is rather simple:
Sounds pretty easy, doesn't it? Well, it really is. Of course, every step of the process has its own set of actions, which we will see later on, but that is it basically.
# What tools do we need?
We use three tools for our work: **Git**, **a text editor** and **Gitea**.
We use three tools for our work: **Git**, **a text editor** and **Forgejo**.
We choose **Git** for several reasons, the main one being our documents structure and code language. Even though there are many (and very good ones) translation tools which look more "user friendly", none of them fit our use case or have **Markdown** text format support out-of-the-box. In the best scenario, it will requires us to make massive modifications on the files in order to strip them down into several "text sections" or "strings". Another important reason is that **Git** allows us to keep track on the changes made on those files, making it easier to manage and collaborate on them. And one more reason is that **Gitea** (the code hosting software we use with **Git**) has a lot of useful features to organize and improve the work in one single place.
We choose **Git** for several reasons, the main one being our documents structure and code language. Even though there are many (and very good ones) translation tools which look more "user friendly", none of them fit our use case or have **Markdown** text format support out-of-the-box. In the best scenario, it will requires us to make massive modifications on the files in order to strip them down into several "text sections" or "strings". Another important reason is that **Git** allows us to keep track on the changes made on those files, making it easier to manage and collaborate on them. And one more reason is that **Forgejo** (the code hosting software we use with **Git**) has a lot of useful features to organize and improve the work in one single place.
OK, let's check our tools:
1. **Git**: If you are a **GNU/Linux** user it is highly probable that you already have it installed (you can check in your software package manager or through the terminal with the command `which git`). If you are using **Microsoft Windows** or **Mac OS**, you can download it from [here](https://git-scm.com/downloads).
2. **A text editor**: Although there are many of them, we suggest you to use one with **Markdown** format support and **Git** integration. **Kate Editor**, **Atom Text Editor** and **VSCodium**, meet this criteria natively, and they are also Free/Libre and Open Source multiplatform software. But, **for practical reasons, we will only see how to work in Atom** (in the future we will include other tools).
2. **A text editor**: Although there are many of them, we suggest you to use one with **Markdown** format support and **Git** integration. **Kate Editor**, **Pulsar Text Editor** and **VSCodium**, meet this criteria natively, and they are also Free/Libre and Open Source multiplatform software. But, **for practical reasons, we will only see how to work in Pulsar** (in the future we will include other tools).
**Atom Text Editor**: [Download](https://atom.io/) · [Source code](https://github.com/atom/atom)
**Pulsar Text Editor**: [Download](https://pulsar-edit.dev/) · [Source code](https://github.com/pulsar-edit/pulsar)
3. **A Disroot Gitea account**: In order to be able to submit your work, you will need to register an account on our **Gitea** instance (**Disroot** credentials will not work) and request access to our repository.
3. **A Disroot Forgejo account**: In order to be able to submit your work, you will need to register an account on our **Forgejo** instance (**Disroot** credentials will not work) and request access to our repository.
[**Register a new account**](https://git.disroot.org/user/sign_up) on **Disroot's Gitea** instance.
[**Register a new account**](https://git.disroot.org/user/sign_up) on **Disroot's Forgejo** instance.
Once you have these tools, it is time to set them up.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 271 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 352 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 646 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 678 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.7 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 157 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 114 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 537 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 531 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 259 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.5 KiB

View File

@ -3,28 +3,28 @@ title: Interface
published: true
visible: true
updated:
last_modified: "January 2022"
app: Atom Text Editor
app_version: 1.58.0
last_modified: "October 2023"
app: Pulsar Text Editor
app_version: 1.10.2023102604
taxonomy:
category:
- docs
tags:
- contribute
- atom
- pulsar
- git
page-toc:
active: true
---
# Getting familiar with Atom
Let's start by getting to know the interface a little bit. Once we have started Atom we will see that it is quite straightforward.
# Getting familiar with Pulsar
Let's start by getting to know the interface a little bit. Once we have started Pulsar we will see that it is quite straightforward.
![](en/atom_01.png)
![](en/pulsar_01.png)
First thing we need to do is to open the Howto project folder that we have just cloned. To do that we can either go to the **File menu** --> **Open Folder** and select the directory or directly from the **Add folders** button at the left.
![](en/atom_interface.png)
![](en/pulsar_interface.png)
The left panel is the project's navigation tree and the main window is the editor where we will edit the files.
@ -32,11 +32,11 @@ The left panel is the project's navigation tree and the main window is the edito
At the bottom is the "status bar" which displays, at the left, the path of the file we are working on and, at the right, information related to the code language, the current branch, some Git actions menu and the number of files we have modified.
![](en/status.bar.png)
![](en/status_bar.png)
Clicking on the **Git** button at the right side of the status bar will display the Git panel where we can view all the files we have modified as well as some Git operations that we can perform (and that we will see later on).
![](en/git.panel.gif)
![](en/git_panel.gif)
We can also toggle the panels if we need to focus just on the text editor.
@ -48,9 +48,9 @@ We can activate the **Markdown preview** to have a visual idea of what are we do
... and we can open and work on multiple files in tabs or splitting the screen into several panels.
![](en/splitted.panels.png)
![](en/splitted_panels.png)
**Atom** is highly customizable, to the point we can tweak practically each and every one of its parts to better suit our needs.
**Pulsar** is highly customizable, to the point we can tweak practically each and every one of its parts to better suit our needs.
The two last things to note before we start to work are:

Binary file not shown.

After

Width:  |  Height:  |  Size: 139 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 461 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 582 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.8 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 157 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 237 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.5 KiB

View File

@ -1,5 +1,5 @@
---
title: Working with Atom + Git
title: Working with Pulsar + Git
published: true
visible: true
updated:
@ -8,13 +8,13 @@ taxonomy:
- docs
tags:
- contribute
- atom
- pulsar
- git
page-toc:
active: true
---
# Working with Atom + Git
# Working with Pulsar + Git
Finally we get to the most interesting part! Let's review what we have done so far.
We have got an exact copy of the **Disroot Howto** folder where are all the files we can see online when we need to learn something about how a service works or how to configure a client.
@ -34,11 +34,11 @@ When the translation is done, it is "submitted" to the remote repository to be r
OK. Let's create our branch so we can start working.
In the bottom-right corner of **Atom**, click on **master** (or any other branch name) and choose **New Branch**. A good practice is to give it a name descriptive enough so that others can easily figure out what we are working on when they see it. For example, if we plan to translate the Nextcloud howto, we could call it "cloud_language_translation" or something similar.
In the bottom-right corner of **Pulsar**, click on **master** (or any other branch name) and choose **New Branch**. A good practice is to give it a name descriptive enough so that others can easily figure out what we are working on when they see it. For example, if we plan to translate the Nextcloud howto, we could call it "cloud_language_translation" or something similar.
Once we are done we press **Enter** on our keyboard.
![](en/atom-branch1.gif)
![](en/pulsar_branch1.gif)
In the terminal, we should use the `git branch` command like this:
@ -46,7 +46,7 @@ In the terminal, we should use the `git branch` command like this:
To switch between branches we can also use this menu. Our current working branch is visible on the bottom bar. If we click on it other local branches will appear.
![](en/atom-branch2.gif)
![](en/pulsar_branch2.gif)
Switching between branches in the terminal is done with the command `git checkout`. If, for example, we want to switch from our current branch to the main one, we should write:
@ -57,7 +57,7 @@ And viceversa, from the main branch to our branch:
`git checkout our.branch.name`
### Publishing our branch
We have created a local branch and we can start translating or writing a howto. For this branch we just created to also exist in the remote repository we need to **publish** it. In Atom it is done using the **Publish** function. When we click on it, we will be asked to enter our credentials. We need to enter our Gitea username and password.
We have created a local branch and we can start translating or writing a howto. For this branch we just created to also exist in the remote repository we need to **publish** it. In Pulsar it is done using the **Publish** function. When we click on it, we will be asked to enter our credentials. We need to enter our Forgejo username and password.
![](en/publish.png)
@ -91,7 +91,7 @@ To do a "commit" of the changes is a process that consists of the following step
All the changes we have done so far in our local branch, they were made in our "working directory" and now we need to "move" them to the "staging" area. "Staging" refers to the moment in which those changes are selected to be included in the next commit.
In Atom, this process is incredibly easy. Let's check the process again:
In Pulsar, this process is incredibly easy. Let's check the process again:
![](en/committing.png)
@ -100,7 +100,7 @@ In Atom, this process is incredibly easy. Let's check the process again:
3. write a **commit message** and finally
4. commit the changes by clicking the **Commit** button.
![](en/atom-commit.gif)
![](en/pulsar_commit.gif)
Now let's see how to do the same but in the terminal.
@ -133,9 +133,9 @@ Once the files are committed, it is time to **push** (send) them to the remote r
## Pushing the changes
We have committed all the changes in our local branch and we want now "upload" them to the remote repository.
In Atom this can be done by simply clicking on the **Push** option in the bottom bar.
In Pulsar this can be done by simply clicking on the **Push** option in the bottom bar.
![](en/atom-push.gif)
![](en/pulsar_push.gif)
In the terminal, we have already seen the command to do this: `git push`. So, to push our local changes to the remote branch we have to write:
@ -151,25 +151,25 @@ Once we think our work is finished and ready to be published on the website, it
This merge operation is done by the **Disroot** admins. But it is us who have to request that it be done.
In **Gitea** it is called **Pull Request** and the procedure, in principle, is pretty simple.
In **Forgejo** it is called **Pull Request** and the procedure, in principle, is pretty simple.
1. We go to **Disroot's Git** site at [**git.disroot.org**](https://git.disroot.org) and login with our **Gitea** credentials.
1. We go to **Disroot's Git** site at [**git.disroot.org**](https://git.disroot.org) and login with our **Forgejo** credentials.
2. Next we need to look for our branch in the **Howto** repository, select it and then click on the **New Pull Request** button.
![](en/pull.request.gif)
![](en/pull_request.gif)
3. In the next page we can do a last and more visual revision of the commits we have made and, if we find it OK, then press the **New Pull Request** again.
![](en/pull.request.2.png)
![](en/pull_request2.png)
4. Now we are required to write a "merge request" message. It does not need to be long and detailed but descriptive enough, similar to the commit message one, in order to make it easy to others to know what the changes are about. We can also (and it is recommended) add labels for better identification.
![](en/pull.request.3.png)
![](en/pull_request3.png)
5. In the last step we can assign "Reviewers", add "Labels" (if we did not do it previously), link our Pull Request to a "Milestone" or a "Project" and define who will be assigned to manage the request (usually the same **Disroot** admins with whom we have been in contact in the Howto's XMPP room).
![](en/pull.request.4.png)
![](en/pull_request4.png)
That's it. \O/
@ -182,9 +182,9 @@ Pull is an operation to update a local version of a remote repository.
If we want to keep the local main branch for future translations or howtos we will need to "pull" the changes integrated to the recently updated remote because ours will no longer be up-to-date with the remote main one.
In Atom we only need to click on the **Pull** function at the right in the status bar.
In Pulsar, all we need to do is right-click on the **Fetch** function and select **Pull** from the drop-down context menu.
![](en/atom-pull.gif)
![](en/pulsar_pull.gif)
In the terminal, this is done with the command `git pull`. So if we are still on our local branch and we want to "update" it after commits were sent and accepted, we need:

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 111 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

View File

@ -11,7 +11,7 @@ taxonomy:
- contribute
- git
- editors
- atom
- pulsar
page-toc:
active: true
---
@ -19,11 +19,8 @@ page-toc:
# Editors
The easiest way to work and edit the **Howto** files is through a text editor with Git integrated.
As we mentioned before, for practical reasons, we will only see how to do it in **Atom Text Editor**, although you can choose to use any other. Along with every step to follow in the editor we will also see the Git commands in the terminal to learn and understand what are Atom and Git doing.
As we mentioned before, for practical reasons, we will only see how to do it in **Pulsar Text Editor**, although you can choose to use any other. Along with every step to follow in the editor we will also see the Git commands in the terminal to learn and understand what are Pulsar and Git doing.
We will try to add more howtos about using other editors in the future. If you want and have time, you can also write one yourself about your favorite editor and we can add it to this section.
## ⚠️ Warning
Atom is no longer in development and this tutorial is outdated. You can use [Pulsar](https://pulsar-edit.dev/) instead as it is a community-developed continuation of Atom editor.
## [Atom](atom/interface)
## [Pulsar](pulsar/interface)