Skip to content

Commit

Permalink
Merge pull request #3 from tu2-atmanand/dev-updating
Browse files Browse the repository at this point in the history
Page update and grammatical errors
  • Loading branch information
tu2-atmanand authored Dec 9, 2024
2 parents 504396d + 2202b0e commit e161fa6
Show file tree
Hide file tree
Showing 15 changed files with 47 additions and 35 deletions.
5 changes: 5 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"cSpell.words": [
"Kanban"
]
}
25 changes: 16 additions & 9 deletions docs/Advanced/HowToJoinDevelopment.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ title: Join the plugin Development

Advanced {: .label .label-yellow }

To contribute for development of this project on github, I have made few fixed repositories for now, which have their specific tasks.
To contribute for development of this project on github, I have made few fixed repositories for now, which have their specific intent.

The complete workflow can be tracked from the Task Board GitHub Project.
The complete workflow can be tracked from the [Task Board GitHub Project](https://github.com/users/tu2-atmanand/projects/2).

You can go through which issue/feature has been worked on at present, which issues are ready to be implemented and which issues has not been assigned at present to anyone or havent been started yet.
You can go through which issue/feature has been worked on at present, which issues are ready to be implemented and which issues has not been assigned at present to anyone or haven't been started yet.

If you feel like, you can work on any issue which has not been assigned to any one. Then open the issue, go to the end and add a new comment by taggin the project admin and mention that you want to start working on this project. Also ensure that, no one else has commented the same, else it will be same work being done by two people.
If you feel like, you can work on any issue which has not been assigned to any one. Then open the issue, go to the end and add a new comment by tagging the project admin and mention that you want to start working on this issue. Also ensure that, no one else has commented the same, else it will be same work being done by two people.

After mentioning this you can directly start working on the issue by [creating a fork]() of the project and then creating a new branch from the `pluginTesting` branch.

Expand All @@ -23,13 +23,20 @@ After mentioning this you can directly start working on the issue by [creating a

### Main

- This branch will only contain the code for publishing. This branch will only accept Pull request or merge request through `pluginTesting` branch. First a proper testing should be done in the pluginTesting branch to merge changes to main branch.
- This branch will only contain the code for publishing. This branch will only accept merge request through `pluginTesting` branch. First a proper testing should be done in the pluginTesting branch to merge changes to main branch. This will be done by the project admin.

### pluginTesting

- This branch will be always on the latest working code. After any new functionality implementation has been done or any bug has been resolved, it will be alwats merged to this branch.
- This branch will be always on the latest working code. After any new functionality implementation has been done or any bug has been resolved, it will be always merged to this branch.

- After the new merge, a thorogh testing will be done on this branch, to test whether the new additions are working as expected and can be moved on further. After the admin has tested everything a commit will be added to specify the same. After that you can create a new branch from this point of commit to work on a new issue. And the admin will also go for merging new Pull Request to this branch and the process will continue.
- After the new merge, a thorough testing will be done on this branch, to test whether the new additions are working as expected. After the admin has tested everything a commit will be added as : "New changes working".

- You are requested to create a new branch from this commit, to start your development. Since this is the checkpoint that everything has been working as expected.

- While submitting a Pull Request, please ensure that you are submitting the PR on this branch and not on the main branch.
- After the admin has reviewed your contribution, the PR will be accepted and will be merged into the `pluginTesting`.
- All the necessary changes will be done. Remember, if the feature you have suggested doesn't goes well with the overall plugin, then it will be removed at this stage.
- After proper testing, a commit will be made with the comment : "New changes working" as mentioned in the above point.

### cleanupToRelease

Expand All @@ -38,9 +45,9 @@ This branch is to be used, after every planned issue for the upcoming release/mi
In this branch :

- Will remove all the console statements.
- All development code, delete unncesary comments.
- All development code, delete unnecessary comments.
- Write better comments.
- If any strings has been chaged, translate those updated strings to other languages.
- If any strings has been changed, translate those updated strings to other languages.

---

Expand Down
4 changes: 2 additions & 2 deletions docs/Advanced/HowToUseForum.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Use the forum

# How to use the Forum

This forum is basically the GitHub Discussion section of the Task Board repository. Any person using this plugin will be able to answer your query if the admin couldnt able to reach sooner.
This forum is basically the GitHub Discussion section of the Task Board repository. Any person using this plugin will be able to answer your query if the admin couldn't able to reach sooner.

## How to ask a question

Expand All @@ -16,7 +16,7 @@ This forum is basically the GitHub Discussion section of the Task Board reposito
**Step 3 :** You will see the following screen :
![QnA_DiscussionSection](../../assets/QnA_DiscussionSection.png)

**Step 4 :** Add your question in the first field : **Add a title**. Try to keep the questoin short and one liner. You can explain/elaborate your question further inside the body section.
**Step 4 :** Add your question in the first field : **Add a title**. Try to keep the question short and one liner. You can explain/elaborate your question further inside the body section.

**Step 5 :** Elaborate your question further in the **Add a body** section. You can add images or links to documents and sites here.

Expand Down
6 changes: 3 additions & 3 deletions docs/Components/EditTaskWindow.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ This is a pop up window which helps you to edit your tasks or add more fields to

### Left Section

- **Title Input Field :** First there will be a text field to take the Main Title of the task. This can be a complete single task, like a whole paragraph. But Kanban philosophy follows the approach of giving a title to your tasks and then explaining it further in other section. So, it will be a good practive to give a short name to your task, which you will be able to see on the Task Board.
- **Title Input Field :** First there will be a text field to take the Main Title of the task. This can be a complete single task, like a whole paragraph. But Kanban philosophy follows the approach of giving a title to your tasks and then explaining it further in other section. So, it will be a good practice to give a short name to your task, which you will be able to see on the Task Board.

- **Sub-Tasks Section :** Next will be a section to add sub-tasks to your main task. Again it will be recommended to give a short one line summary for creating a sub-task, you can explain further your sub-tasks in the Description section. Sub-Taks only works with single indentation levels, since Obsidian supports multi-layers of indentation, you can add such multi-level indented sub-tasks in the description.
- **Sub-Tasks Section :** Next will be a section to add sub-tasks to your main task. Again it will be recommended to give a short one line summary for creating a sub-task, you can explain further your sub-tasks in the Description section. Sub-Task only works with single indentation levels, since Obsidian supports multi-layers of indentation, you can add such multi-level indented sub-tasks in the description.
- You can either edit the content of your old sub-tasks from the text input field. Or add more sub-tasks using the `Add Sub Task` button, which will create a new text input field for you to enter the new sub-task.

- **Preview / Description Section** : This is a section where you can see two button to change the section in a Section tab.
Expand All @@ -30,7 +30,7 @@ Under this section you can able to add the following fields to your task. All th

- **Task Due Time :** This is a time field, when you will click on this field, you will get a menu to select the time for your task. These section is divided into a Start Time and End Time. This feature will help you, if you are using **Day Planner** plugin, to plan your every day timeline.
- **Start Time :** Enter the time when you are planning to complete your task, this is the time when you will start doing the task.
- **End Time :** By default, when you will select the start time, this field will be automatically populated with an one hour incremented value from your Start Time. You can easily change this value, to chnage the duration of the task.
- **End Time :** By default, when you will select the start time, this field will be automatically populated with an one hour incremented value from your Start Time. You can easily change this value, to change the duration of the task.

- **Task Due Date :** This is a date field. When you will click on this input field, you will be presented with the calender menu to select your date for scheduling the task and the value will be auto populated in the input field, which you can change later as well.

Expand Down
2 changes: 1 addition & 1 deletion docs/Components/MetadataFormats.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You can choose one of the following options in the Task Board setting to keep th
| Dataview | [due:: 2024-10-31] | Any | [priority:: highest] * | #test | [completion:: 2021-10-31T21:52:22] |
| Obsidian Native | @due(2024-10-31) | Any | Any | #test | @completion(2021-10-29) |

- You also have the option to mix these formats with one another. For example, say you dont like to see the emojies for priority, you can use other format, and that will still work.
- You also have the option to mix these formats with one another. For example, say you dent like to see the emojis for priority, you can use other format, and that will still work.
- **Any** mean, for this field, you can use any type of format from that column, for the specific plugin/setting option you have selected.

*Under Development
4 changes: 2 additions & 2 deletions docs/Components/Task_Formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,15 +79,15 @@ But if you haven't added the pipe symbol, then it will look like :
The Description section and the sub-tasks combined are called the **task body**.

- Always ensure to have atleast one-level of indentation for any line to be considered as the part of the task body.
- Also, there shouldnt be an empty line inside the task body, otherwise, the part after the empty line will be considered as a separate content even though it has an indentation. So, this criteria can be used to separate other content from the task content.
- Also, there should not be an empty line inside the task body, otherwise, the part after the empty line will be considered as a separate content even though it has an indentation. So, this criteria can be used to separate other content from the task content.

### Description

The description is basically the further elaboration of the task or even the sub tasks. You can explain as much as you want inside description, add images or attach documents. The description must be created by adding atleast one level indentation compared to the task title.

### Sub Tasks

To Create a subTasks for the main task, its is important that, there has to be atleast one Level indentation and there shouldnt be any empty lines between the task title and the sub-tasks.
To Create a subTasks for the main task, its is important that, there has to be atleast one Level indentation and there should not be any empty lines between the task title and the sub-tasks.

You can have any number of sub-tasks and with multi-indentation. For example:

Expand Down
4 changes: 2 additions & 2 deletions docs/Components/Task_Item_Card.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ By default the Task Description content will be hidden. You will see a light col

The Description content is kept hidden by default is because, there can be a lot of content inside the description for the task, and keeping in visible will consume a lot of board area, which will defeat the methodology of a Kanban Board. Whenever you want to take a look at the content of the Description of any specific task, you can expand it and read the content or make use of the links from the content.

Another thing is, the content will be compressed, that, is the indentaion of the content lines will be removed to save space. The idea here is to just show the content and not to worry about the formatting much, although all the other formatting will be applied like bold, italic, etc. The indentation is removed to again, show all the content in as much less area as posssible. You can look at the actual content by opening the [Edit Task Window](./EditTaskWindow.md) or by directly opening the markdown file.
Another thing is, the content will be compressed, that, is the indentation of the content lines will be removed to save space. The idea here is to just show the content and not to worry about the formatting much, although all the other formatting will be applied like bold, italic, etc. The indentation is removed to again, show all the content in as much less area as possible. You can look at the actual content by opening the [Edit Task Window](./EditTaskWindow.md) or by directly opening the markdown file.

## Footer

Expand All @@ -46,4 +46,4 @@ The Footer section will show the following three task properties :

**2. Task Due Date :** After the Task Duration, you will be able to see the Due date of the task separated from the Duration value by a Pipe symbol. The Due Date will be mention using a Calender Icon before its value.

**3. Button Sectoin :** On the far right in this section, you will able to see two main button, first one is the `Edit Task` button, which will open the Edit Task Window and the second button is `Delete Task`, which will simply delete the task from the board as well as the content will also be removed from the parent markdown file.
**3. Button Section :** On the far right in this section, you will able to see two main button, first one is the `Edit Task` button, which will open the Edit Task Window and the second button is `Delete Task`, which will simply delete the task from the board as well as the content will also be removed from the parent markdown file.
4 changes: 2 additions & 2 deletions docs/Components/Types_Of_Columns.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Intuitively, this column will show you all the tasks, which has not been provide

## Other Tags

Now, after you have understood what are **Untagged** and **Tagged** column, there might be case, where you have given a tag to many tasks and you havent created a **Tagged** type of column for this tasks, then these tasks wont be shown on the board at all, since they also do not fall under the **Untagged** column type criteria. For all these tasks, you can create a **Other Tags** type of column, to show all this tasks under this column
Now, after you have understood what are **Untagged** and **Tagged** column, there might be case, where you have given a tag to many tasks and you haven't created a **Tagged** type of column for this tasks, then these tasks wont be shown on the board at all, since they also do not fall under the **Untagged** column type criteria. For all these tasks, you can create a **Other Tags** type of column, to show all this tasks under this column

### Properties

Expand All @@ -78,7 +78,7 @@ This type of column will show you all the tasks, which has been marked as comple
### Properties

- **Column Name :** The first property will be as usual the name of the column which you want to see on the column header.
- **Max Items :** This is a number value you want to enter to set a limit to the number of task item cards you want to see under this column. This has been kept to limit the number of tasks rendered under this column, because over a time, you might complete lot of tasks, and if you havent deleted these tasks from you vault, then they will be getting appended under this column and will increase the load time of the board, hence setting a limit will help you to show only the latest completed tasks.
- **Max Items :** This is a number value you want to enter to set a limit to the number of task item cards you want to see under this column. This has been kept to limit the number of tasks rendered under this column, because over a time, you might complete lot of tasks, and if you haven't deleted these tasks from you vault, then they will be getting appended under this column and will increase the load time of the board, hence setting a limit will help you to show only the latest completed tasks.

# Upcoming New Column types

Expand Down
Loading

0 comments on commit e161fa6

Please sign in to comment.