Giter Club home page Giter Club logo

docs's Introduction

Vanilla Repo Logo

[![](https://img.shields.io/github/license/vanilla/vanilla.svg)](https://github.com/vanilla/vanilla/blob/master/LICENSE) [![CircleCI](https://circleci.com/gh/vanilla/vanilla/tree/master.svg?style=svg)](https://circleci.com/gh/vanilla/vanilla/tree/master)

Howdy, Stranger!

Vanilla was born out of the desire to create flexible, customizable, and downright entertaining community solutions. Vanilla has been used to power tens of thousands of community forums around the world and we couldn't be happier if you've decided to use Vanilla to grow yours.

Forum Rich Editor Dashboard
image image image

Every community is unique. Vanilla is a finely-crafted platform on which designers and developers can build a custom-tailored environment that meets your community's particular needs.

5 reasons Vanilla is the sweetest forum

  1. We've reimagined traditional forums for mass-appeal.
  2. Our theming flexibility is second-to-none.
  3. Impossibly good integration options with single sign-ons and embedding.
  4. The best tools available for community management.
  5. Curated features with great plugin options, not the kitchen sink.

Installation

The current version of Vanilla requires PHP 7.2+ and MySQL 5.7+. The following PHP extensions are also required: cURL, DOM, Fileinfo, GD, intl, JSON, libxml, PDO

Upgrading from an earlier version of Vanilla? See our upgrade notes.

Changes to Fulltext Indexing

Full-text index support has been disabled by default as of Vanilla 4. To enable full-text index support, add a FullTextIndexing key under the Database section of your site config and set its value to true. Failure to add this config value will result in full-text indexes being removed from Vanilla's database tables.

Contributing

Getting Help

Reporting Security Issues

Please disclose security issues responsibly by emailing [email protected] with a full description or join our bug bounty program. We cannot award bounties outside that program.

We'll work on releasing an updated version as quickly as possible. Please do not email non-security issues; use the issue tracker instead.

Building Releases

Vanilla releases are built using Phing to create a pre-built deploy-ready copies of Vanilla. To build these run the following in the root of the repository.

./bin/release

The following dependenies are all required for building a release.

  • node
  • yarn
  • php
  • composer

License & Legal Stuff

Vanilla is free, open source software distributed under the license gpl-2.0-only. We accept and encourage contributions from our community and sometimes give hugs in return.

Copyright © 2009-2022 Vanilla Forums Inc.

Vanilla Forums is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

Vanilla Forums is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Vanilla Forums.

If not, see http://www.gnu.org/licenses/. Contact Vanilla Forums Inc. at support [at] vanillaforums [dot] com

Bonk!

Just kidding, everything's awesome. dance

docs's People

Contributors

adrianspeyer avatar andrewdodson avatar austins avatar beckyvb avatar bleistivt avatar bparm avatar cdepage avatar charrondev avatar daazku avatar danni-stark avatar falia15 avatar farhanvanilla avatar harolato avatar hgtonight avatar igraziatto avatar initvector avatar josephfleming avatar julievanilla avatar kaecyra avatar kaspar-k avatar lauramakesart avatar linc avatar lucvezina avatar nervoustwit avatar nikoskip avatar petrsvihlik avatar r-j avatar rmzelle avatar shaunamcclemens avatar tburry avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs's Issues

Docs 2.0

Finishing the new version of docs.

Mobile theme needs a ton of work

The mobile experience for our docs is basically hot garbage. Framing is frequently wrong, and the menu is taking up screen space constantly.

Canonical URLs needed

We have an issue with https links being indexed in Google. Best solution I think would be some canonicals in the meta.

SSO documentation needs to be improved

We currently have a lot of support requests about SSO and updating our documentation could help reduce the number or request we receive.

Most of our documentation is built around JsConnect but 50% of it is applicable to any SSO Provider.

Here are some major pain points:

  • Provider set as default SignIn method vs no default.
    • This changes the flow.
    • Having a default provider will make /sso default to /entry/connect/provider?id={PROVIDER_ID}
  • Redirects
    • Most people don't understand that they need to actually redirect to /entry/connect/provider after being signed in. We should explain what is the expected workflow.
    • The Target property needs its own section.
      • We also need to explain that people can use {target} which will automatically be replaced by your forum URL
  • There is no F.A.Q about common issues.

Help: DNS/Custom Domain

Current:
(blog) dang this is old
https://blog.vanillaforums.com/help/custom-domain-name/

Needed:

  • Some more relevant examples and explanations of what to do on the host side of a domain
  • We seem to have some people trying to use “free” domains where they can’t adjust their records? List out requirements for host to support redirect to our domain and for CURL for wordpress widgets
  • Perhaps notate special requests for .co.uk if required

Facebook Connect publish_actions permission

The documentation page for FB Connect should contain information on how to fill in the FB App review form. It's not clear which actions in VanillaForums require the permission -> not clear what to fill in the review form. See the following:

publish_actions is only for custom-built sharing experiences. If your app triggers a Facebook dialog to share, you won't be approved for publish_actions

I tried to disable "social share" and "social reactions" in the FB Connect add-on in Vanilla but the login url contains scope=email,publish_actions no matter what I set.

The review form:
fb_review

Fix analytics doc

The analytics doc is currently broken:

screen shot 2017-07-11 at 12 43 16 pm

Some term have also changed.. (We now have a mix in of "number of" and "count of")
We should also add a lexicon section.

Help: WordPress

PHP Syntax Highlighting

I noticed that code examples don't have syntax highlighting which is not cool. Can we get at least javascript syntax highlighting included?

Click targets on side menus should be larger

In the side menus only the text is clickable to navigate. I should be able to click the padding around the text and the expand/collapse arrows. Nothing should change visually. Just make the padding on the anchors bigger and the padding on the list items smaller. Probably some miscellaneous CSS foozbamery.

vanilla_forums_documentation

Suggest moderation section

  • Overview
    • inline moderation actions
    • Warnings
    • Banning
    • Abuse reaction
    • Changelog
    • etc.

There are probably some videos that can be embedded.

Update docs on Locale overrides.

The docs currently state

If you are using Multilingual to enable multiple locales, please note his override will effect all locales. There is currently no way to override multiple locales selectively.

This is no longer true. The docs should be updated with a section on overriding strings in particular locales.

Help: Spam Handling Options

Current:
(docs) curbing spam with ranks http://docs.vanillaforums.com/addons/ranks/using-ranks-to-defeat-spam-or-abuse/

(docs) spam and reactions
http://docs.vanillaforums.com/addons/reactions/curating-with-reactions/

(blog) Overview
https://blog.vanillaforums.com/help/stop-forum-spam/

(blog) More Overview https://blog.vanillaforums.com/help/9-ways-to-eliminate-spam-in-your-community-forum/

Needed:

  • Check accuracy and add burner blocker to suggestions
  • Specifics about Verified Status

I'd like to swing a centralized doc that links people to appropriate options in other addons, while pulling the Stop Forum Spam info out of the blog.

API v2 docs

Getting a separate API docs system online that is easy to use, beautiful, and automated.

Help: Posting

This section should explain how to make new comments and discussions, and go over the editor and its opens.

Help: Pockets

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.