Loading...
 

Gitpod

How to use Gitpod for Tiki development


gitpod.yml support was added to Tiki!

So, What is Gitpod...?

Well, Gitpod is a cloud-based integrated development environment (IDE) that runs on top of GitLab, GitHub, and Bitbucket.
It enables developers to start coding immediately by providing pre-configured development environments for projects stored in Git repositories. This means that developers can launch a fully-functional development environment in their web browser without having to install or configure any software. Gitpod offers a range of features such as live collaboration, task management, and integration with popular tools and services like Docker and Kubernetes.
So, It's an online IDE that runs in your browser and can be used to develop and manage software projects. It can be used with TikiWiki to streamline the development process and provide a more convenient and efficient way of working with the Tiki codebase, and all that, in your browser!

Okay, How can you actually use it for Tiki development...?

That's actually super simple! All you need is to navigate to the Tiki repository on GitLab, https://gitlab.com/tikiwiki/tiki, start a Gitpod "workspace", and you'll be ready to go.

Here's how to do it in a few steps:

  • First, you need to enable Gitpod integration:
    Under your profile, go to "Preferences" -> scroll down to "Integrations" -> and check the "Enable Gitpod integration" checkbox

  • Then, click on the dropdown arrow next to the Web IDE split button on the project, and choose Gitpod.

Gitlab Edit Modes

  • Click on the "Gitpod" button now as it is the one selected, to launch the workspace.


Image
This will launch a new workspace in the Gitpod cloud and configure it to use the Tiki repository as the code base.

Wait for the workspace to start and the environment to be set up. This process may take several minutes, as Gitpod will download and install all the necessary dependencies, such as the PHP interpreter and the web server. So, don't worry if it seems to take forever... ?

Once the environment is ready, Gitpod will provide you with an integrated VS Code editor so you can make changes to the Tiki code, a CLI to run commands, a built-in web server, and even a integrated web browser to preview your changes live. That's great, isn't it! ?

Take a look...
Gitpod Opened Browser

When you are ready to push your changes back to the Tiki repository, you can use the Git version control system to manage the changes and collaborate with other contributors.

Let's have an example (a quick demo)

So, in this example we are going to make a small modification in the README file: adding a link to this Tiki+Gitpod documentation.

Image


At this stage, if you go back to the repo you can see that the changes have been pushed (as seen in the next image), and you are able to create a Merge Request

Latest Push

That's it! You are now ready to use Gitpod for Tiki development. With Gitpod, you can easily set up a development environment and start coding, without having to worry about installing software or configuring your local machine.
Overall, using Gitpod with Tiki can simplify and speed up the development process by providing a unified environment for coding, testing, and collaboration.
And because Gitpod is cloud-based, you can access your workspace and your code from any device with an internet connection, which provides a great deal of flexibility and mobility for your development work. You don't have to worry about the limitations of your local machine or worry about the setup and configuration of a development environment, as Gitpod takes care of all that for you. This also makes it easier for you to collaborate with other developers, as you can share workspaces and work on code together in real-time.


See also: GitLab Web IDE and Vagrant


Use cases

  • New developers (Xdebug is enabled, code indentation, etc.)
  • Translators (change English strings)
  • Compile themes
  • Produce release (with the right credentials)
  • One day: How to upgrade Cypht within Tiki via Composer (now missing composer.phar)

Keywords

The following is a list of keywords that should serve as hubs for navigation within the Tiki development and should correspond to documentation keywords.

Each feature in Tiki has a wiki page which regroups all the bugs, requests for enhancements, etc. It is somewhat a form of wiki-based project management. You can also express your interest in a feature by adding it to your profile. You can also try out the Dynamic filter.

Accessibility (WAI & 508)
Accounting
Administration
Ajax
Articles & Submissions
Backlinks
Banner
Batch
BigBlueButton audio/video/chat/screensharing
Blog
Bookmark
Browser Compatibility
Calendar
Category
Chat
Comment
Communication Center
Consistency
Contacts Address book
Contact us
Content template
Contribution
Cookie
Copyright
Credits
Custom Home (and Group Home Page)
Database MySQL - MyISAM
Database MySQL - InnoDB
Date and Time
Debugger Console
Diagram
Directory (of hyperlinks)
Documentation link from Tiki to doc.tiki.org (Help System)
Docs
DogFood
Draw -superseded by Diagram
Dynamic Content
Preferences
Dynamic Variable
External Authentication
FAQ
Featured links
Feeds (RSS)
File Gallery
Forum
Friendship Network (Community)
Gantt
Group
Groupmail
Help
History
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
jQuery
Kaltura video management
Kanban
Karma
Live Support
Logs (system & action)
Lost edit protection
Mail-in
Map
Menu
Meta Tag
Missing features
Visual Mapping
Mobile
Mods
Modules
MultiTiki
MyTiki
Newsletter
Notepad
OS independence (Non-Linux, Windows/IIS, Mac, BSD)
Organic Groups (Self-managed Teams)
Packages
Payment
PDF
Performance Speed / Load / Compression / Cache
Permission
Poll
Profiles
Quiz
Rating
Realname
Report
Revision Approval
Scheduler
Score
Search engine optimization (SEO)
Search
Security
Semantic links
Share
Shopping Cart
Shoutbox
Site Identity
Slideshow
Smarty Template
Social Networking
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Staging and Approval
Stats
Survey
Syntax Highlighter (Codemirror)
Tablesorter
Tags
Task
Tell a Friend
Terms and Conditions
Theme
TikiTests
Federated Timesheets
Token Access
Toolbar (Quicktags)
Tours
Trackers
TRIM
User Administration
User Files
User Menu
Watch
Webmail and Groupmail
WebServices
Wiki History, page rename, etc
Wiki plugins extends basic syntax
Wiki syntax text area, parser, etc
Wiki structure (book and table of content)
Workspace and perspectives
WYSIWTSN
WYSIWYCA
WYSIWYG
XMLRPC
XMPP




Useful Tools