Skip to content

Commit

Permalink
add initiale structure
Browse files Browse the repository at this point in the history
Signed-off-by: Tantic <[email protected]>
  • Loading branch information
tantic committed Sep 8, 2024
1 parent fccbddc commit 6748915
Show file tree
Hide file tree
Showing 111 changed files with 174 additions and 597 deletions.
47 changes: 0 additions & 47 deletions docs/intro.md

This file was deleted.

7 changes: 7 additions & 0 deletions docs/redmine/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 1
---

# Introduction

Some documentation about Redmine that is not in the official documentation
8 changes: 8 additions & 0 deletions docs/theme/administration/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Administration",
"position": 4,
"link": {
"type": "generated-index",
"description": "Administration of the plugin."
}
}
5 changes: 5 additions & 0 deletions docs/theme/administration/issue_statuses.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 3
---

# Issue statuses
5 changes: 5 additions & 0 deletions docs/theme/administration/login.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 1
---

# Login page
5 changes: 5 additions & 0 deletions docs/theme/administration/logo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 2
---

# Logo
8 changes: 8 additions & 0 deletions docs/theme/development/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Development",
"position": 5,
"link": {
"type": "generated-index",
"description": "Contributing to the plugin."
}
}
5 changes: 5 additions & 0 deletions docs/theme/development/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 1
---

# Contributing
8 changes: 8 additions & 0 deletions docs/theme/features/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Features",
"position": 3,
"link": {
"type": "generated-index",
"description": "All the features of the plugin."
}
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/activities.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/activities2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/admin-custom-fields.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/admin-enumerations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/admin-groups.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/admin-infos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/admin-issues-statuses.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/admin-ldap.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/admin-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/admin-plugins.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/admin-projects-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/admin-projects.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/admin-role-edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/admin-roles-edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/admin-roles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/admin-trackers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/admin-users.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/admin-workflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/admin_issue_statuses.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/dark2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/features/img/dark3.png
Binary file added docs/theme/features/img/documents.png
Binary file added docs/theme/features/img/files.png
Binary file added docs/theme/features/img/first-issue.png
Binary file added docs/theme/features/img/first-issues.png
Binary file added docs/theme/features/img/first.gif
Binary file added docs/theme/features/img/flash-message.png
Binary file added docs/theme/features/img/forum.png
Binary file added docs/theme/features/img/issue_20240118.gif
Binary file added docs/theme/features/img/issue_20240118.png
Binary file added docs/theme/features/img/issue_20240701.png
Binary file added docs/theme/features/img/issue_overview.png
Binary file added docs/theme/features/img/issues.png
Binary file added docs/theme/features/img/issues2.png
Binary file added docs/theme/features/img/issues3.png
Binary file added docs/theme/features/img/issues_20240229.png
Binary file added docs/theme/features/img/login.png
Binary file added docs/theme/features/img/mobile.png
Binary file added docs/theme/features/img/navbar.png
Binary file added docs/theme/features/img/navigation-2.png
Binary file added docs/theme/features/img/navigation-3.png
Binary file added docs/theme/features/img/navigation.png
Binary file added docs/theme/features/img/news.png
Binary file added docs/theme/features/img/project_activities.png
Binary file added docs/theme/features/img/project_calendar.png
Binary file added docs/theme/features/img/project_documents.png
Binary file added docs/theme/features/img/project_files.png
Binary file added docs/theme/features/img/project_forum.png
Binary file added docs/theme/features/img/project_gantt.png
Binary file added docs/theme/features/img/project_issues.png
Binary file added docs/theme/features/img/project_navigation.png
Binary file added docs/theme/features/img/project_news.png
Binary file added docs/theme/features/img/project_overview.png
Binary file added docs/theme/features/img/project_repositories.png
Binary file added docs/theme/features/img/project_roadmap.png
Binary file added docs/theme/features/img/project_settings.png
Binary file added docs/theme/features/img/project_timelog.png
Binary file added docs/theme/features/img/project_wiki.png
Binary file added docs/theme/features/img/projects.png
Binary file added docs/theme/features/img/projects_list.png
Binary file added docs/theme/features/img/redmine_about.png
Binary file added docs/theme/features/img/redmine_calendar.png
Binary file added docs/theme/features/img/redmine_gantt_v0.png
Binary file added docs/theme/features/img/repository.png
Binary file added docs/theme/features/img/roadmap.png
Binary file added docs/theme/features/img/second.png
Binary file added docs/theme/features/img/spent-time.png
Binary file added docs/theme/features/img/three.png
Binary file added docs/theme/features/img/user-profile.png
Binary file added docs/theme/features/img/user-settings.gif
Binary file added docs/theme/features/img/welcome-1.png
Binary file added docs/theme/features/img/welcome.png
Binary file added docs/theme/features/img/wiki.png
Binary file added docs/theme/features/img/wiki2.png
Binary file added docs/theme/features/img/wiki3.png
Binary file added docs/theme/features/img/wiki4.png
13 changes: 13 additions & 0 deletions docs/theme/features/screenshots.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
sidebar_position: 1
---

# Screenshots

## Login page

![Login](./img/login.png)

## Welcome page

![Login](./img/welcome-1.png)
14 changes: 14 additions & 0 deletions docs/theme/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
sidebar_position: 2
---

# Installation

This plugin has been tested with Redmine 5.1.x

```
cd $REDMINE_ROOT
git clone https://github.com/tantic/redmine_asap_theme.git plugins/redmine_asap_theme
bundle install
bundle exec rake redmine:plugins:migrate RAILS_ENV=production
```
48 changes: 48 additions & 0 deletions docs/theme/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
sidebar_position: 1
---

# Introduction

This plugin try to propose a new UX/UI for Redmine and try new tools like stimulus/turbo and Tailwindcss (one day Hotwire :smiley:).

* Status : in development and for fun not a real plugin for now.
* Compatibility : Redmine 5.1.1

If you want to test it quickly with docker, you can use the repo https://github.com/tantic/redmine_asap_docker.git


## Why?

Redmine is really powerful. Really. Many features and really customizables.
But I have to say that after 10 years of using it, the UX and the UI are now quite old and not as attractive as it used to be, well at least in my point of view.

So let's try to do something different! First version just a new version not a revolution, we'll see later how this could better.

## What?

A brand new theme whith a new layout and some principles
* should be clean and simple (only show main features first and then show other features on demand)
* should help to navigate really quickly
* should implement new features or integrate small ones from open-source plugins
* main features are : issue and projet
* as a user I want to create a new project easily
* as a user I want to create a new issus easily and update/delete it really quickly

## How?

* Plugin instead of a theme so that we can reorder items and add stimulus
* Tailwind css and sometimes flowbite
* Stimulus for interactivity, turbo for performances
* integration of small improvments seen in open sources plugins
* try to keep the compatibility with plugins when possible

## Rails and Hotwire

I think Hotwire is really great and really cool for progressive enhancement (see the article here : https://boringrails.com/articles/thinking-in-hotwire-progressive-enhancement/).

So here, the proposition is to improve Redmine
* Step 1 : improve UI with some css
* Step 2 : improve some UX with stimulus and Turbo for the navigation and performances
* Step 3 : go deeper in the UX improvment with some Hotwire stuff
* Step 4 : add some new features
8 changes: 0 additions & 8 deletions docs/tutorial-basics/_category_.json

This file was deleted.

23 changes: 0 additions & 23 deletions docs/tutorial-basics/congratulations.md

This file was deleted.

34 changes: 0 additions & 34 deletions docs/tutorial-basics/create-a-blog-post.md

This file was deleted.

57 changes: 0 additions & 57 deletions docs/tutorial-basics/create-a-document.md

This file was deleted.

43 changes: 0 additions & 43 deletions docs/tutorial-basics/create-a-page.md

This file was deleted.

31 changes: 0 additions & 31 deletions docs/tutorial-basics/deploy-your-site.md

This file was deleted.

Loading

0 comments on commit 6748915

Please sign in to comment.