vanilla / docs Goto Github PK

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.

Twitter setting image not loading

On this page: http://docs.vanillaforums.com/help/addons/social/twitter/index.html
the image for settings is not showing, even though loaded:

https://github.com/vanilla/docs/blob/master/static/img/help/addons/social/twitter/settings.png

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

Help: Posting

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

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.

Research and choose API docs engine

Current candidate is Slate: https://github.com/lord/slate

Update theming docs

Update information in the "about.php" file
- Basics
- About.php

Help: Tagging

Current:
(blog) Overview https://blog.vanillaforums.com/help/how-to-use-tags-tagging-in-your-vanilla-community/

Needed:
Just needs to be converted into a doc, really. Screenshots will need to be updated, as well.

Suggest adding a help doc on SPAM prevention

https://blog.vanillaforums.com/?s=spam

Zendesk & Salesforce integration docs

Why each exists.
What each does.
What they do NOT do.
How to set them up.
Troubleshooting steps / FAQ.

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.

Hook up search box to indexer via Javascript

Should work similar to v1 vanilla-docs repo.

Document addon.json format

Help: Multilingual

Current:
(blog) feature announcement
https://blog.vanillaforums.com/features/support-for-multilingual-community-forums/

(blog) Theme
https://blog.vanillaforums.com/help/friday-theme-tip-customizing-multilingual/

Needed:

Combine
Toggling locales
vs Subcommunities

Help: Advanced Search

Current:
(blog) overview -
https://blog.vanillaforums.com/news/crafting-a-better-forum-search/
(blog) Theme tips https://blog.vanillaforums.com/help/vanilla-forums-friday-theme-tip-advanced-search/
(blog) feature announcement
https://blog.vanillaforums.com/news/vanilla-forums-cloud-software-january-updates/

Needed:

Consolidate all this info
Details on parameters that work

Help: Multisite Sync

This section needs to be filled out.

API v2 docs

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

Write the sync docs for Hub

https://github.com/vanilla/docs/blob/master/content/help/multisite/sync.md

https://vanillaforums.teamwork.com/#tasks/6708871

Document Using modules in themes, how they work

Topics to include:

How modules interact with assets
Moving modules
Example module
Why use a module?

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.

Help: Groups

Current
(docs) Overview-
http://docs.vanillaforums.com/addons/groups/

(docs) Managing groups- http://docs.vanillaforums.com/addons/groups/managing-groups/

(blog) Creating Groups- https://blog.vanillaforums.com/features/creating-groups-in-vanilla-forums/

Needed:
Feature Overview, screenshots
Usage suggestions and examples
Permissions and limitations

Help: Transifex

Current:
(blog) https://blog.vanillaforums.com/developers/translate-vanilla/

Needed:
An actual walkthrough of how to do anything in transifex.

Add API v2 unified record page

We need to standardize the usage of multiple resource types in a dataset. The proposed standardization is located as a comment on vanilla/vanilla#5537. The relevant portions need to be written into a page about the unified record format under Writing APIs.

Caching: overview & tutorial

@linc commented on Thu Dec 18 2014

A tutorial on using the cache methods in Vanilla would be useful!

This Issue was generated from your forums

Help: Emoji

Current:
(docs) list -
http://docs.vanillaforums.com/features/emoji/
(blog) list
https://blog.vanillaforums.com/features/the-complete-list-vanilla-emoji/

Needed:

Update the emoji list,
Add images for the emoji but keep the table itself text based for better searching/copying

Write API v2 resource route docs

Two pages:

Resource routing.
Writing API controllers.

Documentation on testing redirects during a migration

This comes up a lot and I think we should look at it from a few different scenarios. If they are keeping the same domain, if they are changing domains etc.

Document addon.json format

Is there a "VanillaForums.org" newsletter?

In the docs is mentioned that you can subscribe to a newsletter when you visit your profile

I haven't found anything like that...

Write discussion sort/filter module docs

Write docs on the discussions sort/filter module, what it does and how to use it.

Wishlist integration is empty

http://docs.vanillaforums.com/help/integrations/wordpress/wishlist/

Document Time strings

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: