yiisoft-contrib / yiiframework.com Goto Github PK

• Use the same data.
• Use the same URLs.

• http://www.yiiframework.com/wiki/103/use-yii-search-in-your-browser/
• http://www.opensearch.org/Home

It seems we have a problem with users.

• We have at least 2 different domains: yiicamp.com and yiiframework.com.
• User should be identified across these domains.
• Some common data such as avatar, first and last name should be shared.

Additionally there are third party Yii-related projects such as language-specific community websites that will benefit from it.

Any suggestions on the solution?

http://www.yiiframework.com/security/

I think we need it at the new website as well.

It seems people are quite confused about init and expect that its description should be right at downloads page.

It should take 0 clicks to be able to enter a search term.
Search bar should therefore be directly on the main page.

we already have two custom fonts for navigation and content:
118aa88

but monospace is not covered by these and it is smaller than the normal font even though it has the same font size setting...

@samdark can you find a font for monospace?

http://www.yiiframework.com/forum/index.php/topic/62964-https/

It's a good idea to put a short video explaining what is Yii right to the front page.

• Should be short.
• Yii is a PHP framework.
• With Yii PHP doesn't suck :)
• Enhances your productivity (after getting used to it).
• Used by major players: Facebook, FIFA, VICE etc.
• Demo of generating stuff with Gii, console, AR API.

More ideas?

• stoppword filter for non english
  • http://localhost/dev/yiisoft/yiiframework.com/web/search?language=es&version=2.0&q=Sistemas+de+Gesti%C3%B3n
• fine tune boostings http://stackoverflow.com/questions/12427449/elasticsearch-boosting-relevance-based-on-field-value

These are really important and we should automatically build these from sources and provide a way to download these right from website.

Current color scheme is bad in terms of accessability:

http://leaverou.github.io/contrast-ratio/#%2318bc9c-on-white

We should choose a set of colors that have good contrast.

• http://phalconphp.com/en/
• http://www.codeigniter.com/
• http://www.slimframework.com/
• http://cakephp.org/
• http://symfony.com/
• http://laravel.com/

could be linked from the 1.1 guide overview pages, what do you think?

Currently the main navigation causes problems with hash links. linking to a section in the guide or to a method will hide the headline behind the navigation.

two possible solutions:

1. disable stickyness of navigation
2. add some JS that scrolls down 74px every time the hash changes

1. Do we need team members list at the website?
2. If not, is it a good idea to put a link to contributors GitHub page somewhere?

In my projects I usually have a crontab file in the config that is linked to /etc/cron.d/ on the server
so it is possible to configure cronjobs more explicit than having only a set of scripts for hourly, daily, etc...

Was it meant to lead to user guide or internals guide on how to develop Yii itself?

• style of 1.1/1.0 guide
  • image container has no style
  • Tip, Caution etc... hints should be styled (#77)
  • TOC has no style
• style of 2.0 guide
  • Tip, Caution etc... hints should be styled (#77)
  • add TOC
• PDF generation
  • 2.0
  • 1.1
• PDF download
  • 2.0
  • 1.1
• offline docs download
• add blog tutorial

we currently mix these two terms as synonyms a lot over the pages.
We should decide for one term to use everywhere.

Comments for:

• guide pages
  • 1.1 and also fix yiisoft/yii#3844
  • 2.0
• api doc
  • 1.1
  • 2.0

https://www.packtpub.com/web-development/learning-yii-testing

Text:

Embrace 360-degree testing on your Yii 2 projects using Codeception

• Use the same data.
• Use the same URLs.

otherwise we get problems with https and http urls.

images in the guide should be clickable to allow opening it and maybe zoom in in the browser

Please add more:

• vice.com and noisey.com
• humhub.org
• games.com (need to be verified)

copy the current page:

http://www.yiiframework.com/tos/

Linking to the guide is not enough imo.

For "Getting started" there are basically two different entry points:

1. install yii and get a working basic app as soon as possible
2. know about what you need to know and learn and where to find help to get a deep understanding of yii

here is how we have these on IRC:

(23:05:38) CeBe: !faq start
(23:05:39) MrFisk: CeBe: 1) To get started with Yii 2, please read: http://www.yiiframework.com/doc-2.0/guide-README.html#getting-started 2) To learn more, please read the Yii 2 Guide: http://www.yiiframework.com/doc-2.0/guide-README.html 3) Get to know the API docs at http://www.yiiframework.com/doc-2.0/ - you'll use them every day. You can view Yii source code directly in the API docs. The API search box is invaluable.

(23:05:43) CeBe: !faq learn
(23:05:43) MrFisk: CeBe: Here is a step by step To-Do list for Yii beginners. The list is an advice of what tutorials and documentation you can walk through to get a full understanding of the Yii Framework. These can be a help to learn Yii. http://www.yiiframework.com/wiki/268/how-to-learn-yii

features:

• display readme from github
• allow download and composer install
• render api docs and a guide
• link authors from github and display them (yiicamp login should be possible via github)
• ...

We discussed that before but did not do it yet.
http://www.yiiframework.com/forum/index.php/topic/55690-security-mailing-list/

related to #10

clicking through the guide I found that untranslated pages result in a 404 after choosing them from the navigation.
I suggest redirecting to the english version and displaying a flash messages that explains that the page has not been translated yet.

where do we put the news section btw? should they be on yiicamp or yiiframework?
news should be coupled with the comunitiy to allow comments and discussion so I would tend to putting them on yiicamp...

Urls on current framework site are ending with /, e.g. http://www.yiiframework.com/doc/api/
To allow these to be handled by the new site we need to introduce a redirect from URL with slash to URL without slash.

see also:

• yiisoft/yii2#7670
• yiisoft/yii2#8370
• https://github.com/qiangxue/yiiframework.com/blob/master/config/urls.php#L22

normal rendering with js search as we have it now, download as a zip file.

What do you think about such structure (not visual design) of the front page?

• style of 1.1/1.0 docs
  • navigation
  • ensure styling is okay
  • page titles
• style of 2.0 docs
  • ensure styling is okay
  • page titles
• offline docs download
• ...

I've asked my partner usability-expert for help with new UX&Design.
For the start he created mood board(login as guest for quick look).
The goal of mood board is to pick overall stylistics of new sites. It is done for specifying the vector of UX prototyping and future design.
Note, that this is only stylistics - the final color-style will be the same as yii branded colors.
Please take a look at mood board and tell your opinion.
The next step is usability prototyping based on #40 requires a decision.

should they be hosted like normal extensions or do we add them to yiiframework.com?

This is to track old content that will be kept on the new site and possibly necessary redirects.

1. Do we want to display Yii-related books only?
2. Do we need more than cover, Yii version and a link?

http://rghost.ru/download/6ZZK5LxXD/65b315805eec01a58d54b576dd695a668599f482/Yii.pdf

by @bethrezen, to be passed to UX guy

• search concept, what is searchable and how are results represented (yiisoft/yii#3775 (comment))?
  • apidoc 2.0
  • apidoc 1.1
  • guide 2.0
  • guide 1.1
  • blog tutorial 1.1
  • some pages from the site itself (optional)
• search result page style
• suggestions/autocomplete
  • for general terms
  • for api classes and methods like it is now available on current site
• quick reply
• fix yiisoft/yii2-elasticsearch#8
• index guide subsections instead of chapters -> #228

This issue lists things that need to be fixed for the site to work on mobile devices:

• Guide menu is completely hidden on mobile device. should become a dropdown like language and version instead.
• ...

Overall it looks better but...

• Guide text readablity adjustments from previous design lost (contrast, line width, spacing, font, visited link colors etc.)
• Can't sign in if page is scrolled down. Inplace GitHub login could be sufficient for commenting the guide though.
• Use updated logo from current yiiframework.com (w/o shadow). Consider redesigning it while keeping identity.
• Learn menu pops out too much and is hard to navigate. We could remove description since these are more or less obvious from titles.
• No quick access to guide / api which is critical for non-first visitors. Could be added to topmost grey bar.
• Search behaves in a weird unusual way. At least it could auto-focus in the input.
• Learn more and get started buttons are calls to action, need these to be more prominent.

it should be available as soon as you scroll down and bring you back to the top.

should remove the top button from apidoc then.

• https://github.com/yiisoft/yii/labels/type%3Awebsite
• https://github.com/yiisoft/yii2/milestones/website%20and%20infrastructure

1. Framework license is there at GitHub but there's no simple explanation of it's meaning such as presented at http://www.yiiframework.com/license/ currently.
2. Also there's no docs license anywhere in the repository of Yii 2.0.

move the steps from the readme to a makefile.

running it should update everything automatically, currently there are many things to be done manually. And these grow as more features are added.

yiisoft/yii2#6740 (comment)