Best Of

Hi all, look at that https://github.com/vanilla/vanilla/tags

Thanks or the answer @charrondev

I really appreciate you shedding some light on this. I am sorry that a lot of the community management burden of seems to fall on you as you are the only core member still actively responding here.

With the danger of going a little off topic let me explain how I feel about this recent change and how I think it could be leveraged to improve the Vanilla OS environment for everyone.

For the last years I experienced somewhat of a Vanilla fatigue ("burnout" being a too strong word for me). This is also why I am not as active in this forum as I used to be. It can be boiled down to two reasons: The pull request process and the inefficiencies of this forum.

The Pull Request Process

It may come to no suprise that I am (as most people here) myself a frequent user of Vanilla, both on the user and admin side. I have encouraged my users over the last 7 years to report any bugs or glitches they encounter.

Pretty much all of my open source contributions are a direct result of my users reporting bugs to me. I usually patch those for my production environment and then submit a pull request. In the last years it has become increasingly hard not having to maintain a fork of the software.

Just upgrading to the latest open source version before these are merged would introduce regressions my users would immediately notice ("haven't you fixed that some time ago?"). I had to write countless throwaway plugins containing method overrides or dirty hacks to be able to upgrade the forums.

This is not a critique of the team! I understand there are priorities and reviewing and testing code changes takes a lot of time.

I can totally understand the reasons for using a monorepo as well. Daily syncs will probably be a good substitute for regular commits in the vanilla/vanilla repo. To be clear however, there is still a loss for OS contributors. Not having the info about why something was changed, cripples the ability to track down bugs.

I am currently in the process of tracking down a bug with announcements and user-specific discussion data. I don't know if I'll be successful, but without the background information provided by pull requests, issues and git blame data, I don't think it could be done at all.

However, with the new process, I think there are also great opportunities on the horizon. Since commits in vanilla/vanilla no longer directly affects Vanillas production environment, they could all go to a "os-patches" branch that could be merged faster. Faster merges would be more encouraging for new contributors and people who need certain fixes could pull from that branch.

The Inefficiencies of This Forum

The Addon Application

The addon application has been aging very badly and I don't think it is needed very much anymore.

With a large part of the plugins being incompatible with recent versions, sorting by "most downloads" and the confidence rating become meaningless. Trying out plugins is very frustrating for new users since the majority does not work out of the box.

With most of the Vanilla created plugins soon being part of the core, the main reason, people still visit the addon repository on this site is most likely locales. But all locales should probably be included in the OS disctribution anyway. This is how most sofware seems to do it and it would eliminate the problem of having an outdated locale after updating. vanilla/locales zipped size is currently 4 MB which I don't think would be a problem to add to the standard download package.

For all user created plugins I propose a simple alternative: discussions

In my opinion, discussions are actually more suited for plugin discovery:

• New plugins will get more attention as they appear on the recent discussions page
• The discussion can be directly used for feedback: Every plugin having a discussion from the start removes the friction of creating one to ask a support question.
• With a dedicated category for plugins, they can be found using the regular search, which will likely bring up more relevant results anyway.
• This would also mean that the standard moderation and curation tools apply to plugins: New version can receive reactions and plugin threads could be closed if the plugin is unmaintained.

The only caveat I see here is the EditContentTimeout setting, which prevents a discussion starter from adding a new version to the first post. But this is also a good thing as attachment uploads can't be silently switched out that way, which will be just as secure as the current solution, if not more. However, it would require moderators to add a new version to the first post or link the comment with the attachment.

Something has gone wrong.

This is the most asked question on this site. It could be eliminated with a simple message at the top that reads something like this:

Conclusion

I love Vanilla. I have built highly customized communities fully on Vanilla because it is a joy to develop against the framework and I believe in its future. There are many modern community solutions out there, but the value of software like Vanilla that scales and is battle-tested can't be overstated.

Since this was a little long, here is a TL;DR about the relatively cheap changes which, in my opinion, would enhance Vanillas open source environment drastically:

• A message at the top containing debug instructions
• Forum discussions for plugins in place of the addons app
• A branch "OS-fixes" on vanilla/vanilla containing community patches
• Ship the core with all locales

Hi everybody,

As promised in another thread I am currently working on a new library of YAGA reaction icons. After the amazing code contributions to YAGA by @Bleistivt with help from @R_J and @pioc34 as well as others... it is now about time to give the look of reactions a fresher appearance.

This is the old icon table that - especially on retina displays - appears to be blurry and uncrisp.

I started working on new SVG icon set to integrate into YAGA. They will be able to scale to any dimension as they are SVGs. So far I cover some basics and before I come to more special icons I would like to ask the community what could be smart and relevant reactions making sense to many forums.

So first of all, what do you think of it and more importantly which reactions should I create that could be utilized by many communities? 🤔

Please provide one or two sentences of little explanation so I can understand the reaction you propose.

➡️ Current YAGA version can always be found here: https://vanillaskins.com/plugins.html#yaga

Thanx to everyone,

phreak

Hi all,

We from VanillaSkins.com would like to give out our paid plugins to communities who are dealing with topics that are relevant for social stability.

The current corona pandemic is spreading rapidly in Europe. It already affects major industries and not only airports and local shops are ordered to shut down, also critical infrastructure like hospitals and organizations experience disorders. Reports are coming in that internet infrastructure like MS teams, Zoom or Discord are down repeatedly.

Due to the fact that forums like Vanillaforums OS are silos of experience and opinions and can relatively easily be setup on smaller infrastructure, we are offering our paid plugins for free to communities that are directly connected to important parts of our lives and society.

So if you run a community on psychological health, or you manage a forum of an NGO dealing with climate change, a forum on teaching children who can't go to school or you are a part of farmers collective exchanging growth cycles of crops... please contact me if any of our plugins would provide help to your community.

This shall not be empty words seen as a marketing opportunity. Problems surrounding the corona virus got pretty real in the last days events in Europe. I myself manage multiple pregnancy and birth communities and expecting mothers are afraid to go to the hospitals, fathers are not let into delivery rooms and birth clinics are closing. As mothers are asking for home birth opportunities we currently connect midwifes specialized in that field with them. So probably there is an opportunity for your community to help in this situation too. Think about it.

Best regards and keep save,

phreak

I've been using Vanilla for about 5 years, and have developed a maintenance process along the way that has broken down. My goal was to version control our setup (customisations, theme, plugins), and allow for automated deployments like the rest of our stack. I did this by forking the repo and adding to it: for plugins that were on GitHub, I added them as submodules; when they weren't on GitHub, I added their contents to our repo.

This worked for the most part, but upgrading the forums was always a bit of a pain, as we had to rebase and deal with any merge conflicts. We now have a huge number of merge conflicts, to the point that I'd like to start over and make a better setup.

The goal is to create a version controlled forum setup, with reproducible builds, that can run on an ephemeral filesystem (even heroku) so we can load balance it and even blow it away and reconstruct it if necessary. The twelve-factor app provides some background and general principles for this.

To do this, I figure I'll need to:

1. Start from a specific Vanilla release: either a distributed package (zip) or the GitHub codebase (in which case I'd need to run composer).
2. Fill in config.php with settings and secrets, without putting secrets into version control.
3. Pull in our theme, either from a separate git repo or from a directory within this repo, and move it to the themes directory of the Vanilla codebase.
4. Do the same for 10+ plugins, some of which are on GitHub, others which are just .zip files on the addons website.
5. Set conf , cache , and uploads to be writable by PHP.
6. Somehow make uploads a separate volume (like S3) so it can be shared across multiple instances and can persist (even be backed up).

I've started implementing this in a Dockerfile. You can see my progress so far at this repo.

Where I need help

1. config.php

I'm having some trouble with config.php because Vanilla writes to it when an admin makes a change in the admin dashboard: it replaces getenv(...) with the plaintext value. Therefore, if you want to commit any changes made in the dashboard back to source control (say, by mounting config.php as a volume and then making the changes), you'd be committing secrets unless you remember to go back in and change them back to getenv . Solutions to this I've thought of so far are: (a) make it read-only, so the application cannot change it, or (b) consider it a secrets file, outside of source control. But then how would you do an automated deployment? Is there a way to stop Vanilla from writing to config.php ? I would think the database would be better suited for some of these settings, no?

2. Pulling in the theme and plugins

The simplest approach here is for the Dockerfile to just curl and unzip the theme and plugins. I can either put them in the appropriate place in the Vanilla codebase, or symlink them; it doesn't make much difference, I don't think. But it starts to feel like the job of a dependency manager. I could use composer here, but I'd have to either move the installed directory or symlink it to the appropriate place, and I don't think composer can do that, can it? Does anything else come to mind here?

Let me know if there's been any prior work on this, or if anyone wants to collaborate. I'm sure there's ways we can make the repo generic.

There is no tutorial on that and the pager is quite complex, thow you do not need to do much to get it going. After you have set up a working pager, I recommend taking a closer look at the class.pagermodule.php to find out more about its possibilities.

The best way to get going is to look at a page where you can find a pager, e.g. one of the discussions lists (recent discussions, bookmarked, mine etc.) You can find that code in /applications/vanilla/controllers/class.discussionscontroller.php

Let's look at the mine() method, which is quite short, but I stripped out what is not necessary to get a working example:

   public function mine($page = 'p1') {
...
       // Set criteria & get discussions data
       list($offset, $limit) = offsetLimit($page, c('Vanilla.Discussions.PerPage', 30));
...
       $countDiscussions = $this->setData('CountDiscussions', $discussionModel->getCount($wheres));
...
       // Build a pager
       $pagerFactory = new Gdn_PagerFactory();
       $this->EventArguments['PagerType'] = 'MorePager';
...
       $this->Pager = $pagerFactory->getPager($this->EventArguments['PagerType'], $this);
       $this->Pager->MoreCode = 'More Discussions';
       $this->Pager->LessCode = 'Newer Discussions';
       $this->Pager->ClientID = 'Pager';
       $this->Pager->configure(
           $offset,
           $limit,
           $countDiscussions,
           'discussions/mine/%1$s'
       );

       $this->setData('_PagerUrl', 'discussions/mine/{Page}');
       $this->setData('_Page', $page);
       $this->setData('_Limit', $limit);
...
       // Deliver JSON data if necessary
       if ($this->_DeliveryType != DELIVERY_TYPE_ALL) {
           $this->setJson('LessRow', $this->Pager->toString('less'));
           $this->setJson('MoreRow', $this->Pager->toString('more'));
           $this->View = 'discussions';
       }
...
   }

The main element in there is the following block:

       $this->Pager->configure(
           $offset,
           $limit,
           $countDiscussions,
           'discussions/mine/%1$s'
       );

The pager module needs to be configured with those information: where does the current page starts (offset), how much elements does it show (limit), how much elements are there in total (countDiscussions) and where should the previous and next page links should point to.

But look at method code step by step:

   public function mine($page = 'p1') {

In your plugin this will most probably be

   public function pluginController_foo_create($sender, $args) {

The $args array will contain everything that comes after yourforum.com/plugin/foo/...

Therefore, if your url scheme for e.g. the third page should be /plugin/foo/p3, you should have the following code for getting the page for building the pager: $page = $args[0] ?? 'p1';

If your url scheme is /plugin/foo/bar/baz/p3, the required code would be $page = $args[2] ?? 'p1';

       list($offset, $limit) = offsetLimit($page, c('Vanilla.Discussions.PerPage', 30));

This line does a lot! You should look up the function offsetLimit in functions.general.php. What's happening here is that the variables $offset and $limit are filled based on the $page variable and the config value for Vanilla.Discussions.PerPage. I would encoure to make your view configurable in the same way.

       list($offset, $limit) = offsetLimit($page, Gdn::config('Plugins.FooBar.PerPage', 30));

And if it makes sense, you can directly use a Vanilla PerPage setting as default!

        list($offset, $limit) = offsetLimit(
           $page,
           Gdn::config(
               'Plugins.FooBar.PerPage',
                Gdn::config(
                    'Vanilla.Discussions.PerPage',
                    30
                )
            )
        );

The following lines in the snippet are split because that way a plugin author can influence the look and feel of the pager of the mine() method.

       $this->EventArguments['PagerType'] = 'MorePager';
...
       $this->Pager = $pagerFactory->getPager($this->EventArguments['PagerType'], $this);

You can condense it to this line

       $this->Pager = $pagerFactory->getPager('MorePager', $this);

By the way: in most cases when you look at Vanilla code and see $this, you will have to replace that with $sender (if you stick to Vanillas conventions)

Frankly spoken, I'm not sure if you need this block:

       $this->setData('_PagerUrl', 'discussions/mine/{Page}');
       $this->setData('_Page', $page);
       $this->setData('_Limit', $limit);

ANd you have to decide by yourself if that makes sense for you:

       // Deliver JSON data if necessary
       if ($this->_DeliveryType != DELIVERY_TYPE_ALL) {
           $this->setJson('LessRow', $this->Pager->toString('less'));
           $this->setJson('MoreRow', $this->Pager->toString('more'));
           $this->View = 'discussions';
       }

In your view, a simple PagerModule::write() should be sufficient.