Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update help pages #31

Merged
merged 1 commit into from
Nov 14, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions app/assets/assets/help/en/achievements.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Want to contribute on achievements graphics ? Check [this](https://github.com/CaptainFact/captain-fact-frontend/issues/6)!

Achievements are still a work-in-progress and not all of them are implemented yet.

## Common achievements

Common achievements are meant to help you discover the different parts of the site.
Expand Down
16 changes: 0 additions & 16 deletions app/assets/assets/help/en/contribute.md

This file was deleted.

22 changes: 22 additions & 0 deletions app/assets/assets/help/en/contribute/code.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
You can check [our Github](https://github.com/CaptainFact) to see where you can contributes.

# API

* Stack: Elixir + Phoenix
* Status: Not open sourced yet (very soon, we're just waiting for the code reviews on it to be over)
* Repository: *TODO*
* Issues: *TODO*

# Frontend

* Stack: React, Redux
* Status: Open source (AGPL3)
* Repository: https://github.com/CaptainFact/captain-fact-frontend
* Issues: https://github.com/CaptainFact/captain-fact-frontend/issues

# Browser Extension

* Stack: React, Redux
* Status: Open source (AGPL3)
* Repository: https://github.com/CaptainFact/captain-fact-extension
* Issues: https://github.com/CaptainFact/captain-fact-extension/issues
21 changes: 21 additions & 0 deletions app/assets/assets/help/en/contribute/graphic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
CaptainFact is looking for graphic designers who feel inspired by this project. Check below to see how you can
contribute !

## Achievements

CaptainFact has a strong gamification aspect. We want to make it pleasant to contribute and reward users bringing
positive content. One of the ways to achieve that is achievements, like the ones you see in video games. We need them to
be creative and fun, so the main rule here is to take pleasure in what you do ;)

For details about which achievements are currently open to submissions, technical constraints and license stuff checkout
[this Github issue](https://github.com/CaptainFact/captain-fact-frontend/issues/6).

## UI / UX

Though we have graphic designers working from time to time on small aspects of the project (logo...etc) we currently
don't have a "main" graphic designer. Your experience, advices and contributions on the website & extension UI / UX would be extremely valuable.

## Ideas

We're a collaborative project. You have an idea about something incredible we should implement, or how to implement it ?
Contact us or open an issue on our Github!
7 changes: 7 additions & 0 deletions app/assets/assets/help/en/contribute/law.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
None of us is expert in legal questions but we would like to have policies that guarantee our users privacy and control
over their data (hosted in France).

We’re also in favor of a [strong free-speech policy](https://captainfact.io/help/censorship_requests).

Law geek’s passionate about these questions could help us achieving our goals without conflicting with international
laws.
4 changes: 4 additions & 0 deletions app/assets/assets/help/en/contribute/translate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Helping to translate CaptainFact doesn't require any technical skills. We would love having Spanish, German or Chinese
integrated.

If you're interested in translating the project in your own language, be sure that all contributions will be welcomed!
8 changes: 2 additions & 6 deletions app/assets/assets/help/en/privacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,6 @@

<!-- TODO: Add screenshot -->

If you do activate it, the extension will send a request to CaptainFact for every video you play
to ask if the video has been fact checked by the community.
**We do not log these requests**. Privacy is an important matter and this information is not
pertinent for what we want to offer you.
If you do activate it, the extension will send a request to CaptainFact from time to time to sync available videos.

However, you don't have to trust us : activate CaptainFact only when needed if you don't want to
use this feature.
**We do not log nor record the videos you're watching.**
2 changes: 2 additions & 0 deletions app/assets/assets/help/fr/achievements.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Vous souhaitez apporter des ressources graphiques pour cette partie ?
C'est par [ici](https://github.com/CaptainFact/captain-fact-frontend/issues/6)!

Il s'agît d'un travail en cours et tous les accomplissements n'ont pas encore été ajoutés.

## Accomplissements ordinaires

Ces médailles sont là pour vous aider à découvrir les diifférentes parties du site.
Expand Down
17 changes: 0 additions & 17 deletions app/assets/assets/help/fr/contribute.md

This file was deleted.

22 changes: 22 additions & 0 deletions app/assets/assets/help/fr/contribute/code.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Jetez un coup d'oeuil à [notre Github](https://github.com/CaptainFact) pour voir les différents projets.

# API

* Stack: Elixir + Phoenix
* Status: Not open sourced yet (very soon, we're just waiting for the code reviews on it to be over)
* Repository: *TODO*
* Issues: *TODO*

# Frontend

* Stack: React, Redux
* Status: Open source (AGPL3)
* Repository: https://github.com/CaptainFact/captain-fact-frontend
* Issues: https://github.com/CaptainFact/captain-fact-frontend/issues

# Browser Extension

* Stack: React, Redux
* Status: Open source (AGPL3)
* Repository: https://github.com/CaptainFact/captain-fact-extension
* Issues: https://github.com/CaptainFact/captain-fact-extension/issues
21 changes: 21 additions & 0 deletions app/assets/assets/help/fr/contribute/graphic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
CaptainFact is looking for graphic designers who feel inspired by this project. Check below to see how you can
contribute !

## Achievements

CaptainFact has a strong gamification aspect. We want to make it pleasant to contribute and reward users bringing
positive content. One of the ways to achieve that is achievements, like the ones you see in video games. We need them to
be creative and fun, so the main rule here is to take pleasure in what you do ;)

For details about which achievements are currently open to submissions, technical constraints and license stuff checkout
[this Github issue](https://github.com/CaptainFact/captain-fact-frontend/issues/6).

## UI / UX

Though we have graphic designers working from time to time on small aspects of the project (logo...etc) we currently
don't have a "main" graphic designer. Your experience, advices and contributions on the website & extension UI / UX would be extremely valuable.

## Ideas

We're a collaborative project. You have an idea about something incredible we should implement, or how to implement it ?
Contact us or open an issue on our Github!
7 changes: 7 additions & 0 deletions app/assets/assets/help/fr/contribute/law.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
None of us is expert in legal questions but we would like to have policies that guarantee our users privacy and control
over their data (hosted in France).

We’re also in favor of a [strong free-speech policy](https://captainfact.io/help/censorship_requests).

Law geek’s passionate about these questions could help us achieving our goals without conflicting with international
laws.
4 changes: 4 additions & 0 deletions app/assets/assets/help/fr/contribute/translate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Helping to translate CaptainFact doesn't require any technical skills. We would love having Spanish, German or Chinese
integrated.

If you're interested in translating the project in your own language, be sure that all contributions will be welcomed!
10 changes: 4 additions & 6 deletions app/assets/assets/help/fr/privacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,8 @@
Vous pouvez choisir si vous souhaitez activer la reconnaissance des vidéos en un clic à partir de la
popup de l'extension.

Si vous choisissez de le faire, une requête sera envoyée pour chaque vidéo que vous regardez sur Youtube
afin de vérifier si celle-ci a été vérifiée par la communauté.
**Ces requêtes sont anonymes**. La vie privée est une question serieuse et cette information n'est pas
pertinante pour le service que nous voulons proposer.
Si vous choisissez de le faire, une requête sera envoyée régulièrement au serveur lorsque vous visitez Youtube
pour obtenir la liste des vidéos disponnibles.

Vous n'êtes pas obligés de nous faire confiance: activez l'extension uniquement quand celà est nécessaire
si vous ne souhaitez pas utiliser cette fonctionalité.
**Nous n'enregistrons pas les vidéos vous regardez.**

5 changes: 4 additions & 1 deletion app/assets/assets/locales/en/help.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@
"privacy": "Privacy",
"contact": "Contact",
"censorship_requests": "Censorship Requests",
"contribute": "Take part in the project"
"contribute/code": "Programmers",
"contribute/graphic": "Graphic Designers",
"contribute/law": "Lawyers",
"contribute/translate": "Translators"
}
}
6 changes: 5 additions & 1 deletion app/assets/assets/locales/fr/help.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@
"privacy": "Vie Privée",
"contact": "Contact",
"censorship_requests": "Demandes de censure",
"contribute": "Aider à la réalisation du projet"
"contribute": "Aider à la réalisation du projet",
"contribute/code": "Programmation",
"contribute/graphic": "Graphistes",
"contribute/law": "Juristes",
"contribute/translate": "Traducteurs"
}
}
27 changes: 15 additions & 12 deletions app/components/Pages/Help.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ import { reset } from '../../state/help/reducer'
@withRouter
export class Help extends React.PureComponent {
componentDidMount() {
if (this.props.routeParams.pageName)
this.props.fetchHelpPage(this.props.routeParams.pageName)
if (this.props.routeParams.splat)
this.props.fetchHelpPage(this.props.routeParams.splat)
}

componentDidUpdate(oldProps) {
const requestedPageName = this.props.routeParams.pageName
const requestedPageName = this.props.routeParams.splat
if (!requestedPageName)
this.props.reset()
else if (oldProps.routeParams.pageName !== requestedPageName || oldProps.locale !== this.props.locale)
else if (oldProps.routeParams.splat !== requestedPageName || oldProps.locale !== this.props.locale)
this.props.fetchHelpPage(requestedPageName)
if (this.refs.domContent)
this.convertLinks(this.refs.domContent)
Expand All @@ -39,10 +39,10 @@ export class Help extends React.PureComponent {
}

render() {
const { t, routeParams: {pageName} } = this.props
const { t, routeParams: {splat} } = this.props

let header, content
if (!pageName) {
if (!splat) {
header = <h1 className="title is-1">{t('main:menu.help')}</h1>
content = this.renderIndexContent()
} else {
Expand Down Expand Up @@ -94,7 +94,10 @@ export class Help extends React.PureComponent {
</div>
<div className="column panel">
<p className="panel-heading">{this.props.t('categories.contribute')}</p>
{this.renderPageLink('contribute')}
{this.renderPageLink('contribute/code')}
{this.renderPageLink('contribute/graphic')}
{this.renderPageLink('contribute/law')}
{this.renderPageLink('contribute/translate')}
{this.renderPageLink('bug_report')}
{/*TODO Open source*/}
</div>
Expand All @@ -111,22 +114,22 @@ export class Help extends React.PureComponent {
)
}

renderPageLink(pageName) {
renderPageLink(splat) {
return (
<div className="panel-block">
<Link to={`/help/${pageName}`} style={{width: '100%', height: '100%'}}>
{this.props.t(`pages.${pageName}`, {defaultValue: pageName})}
<Link to={`/help/${splat}`} style={{width: '100%', height: '100%'}}>
{this.props.t(`pages.${splat}`, {defaultValue: splat})}
</Link>
</div>
)
}

renderPageHeader() {
const { t, routeParams: { pageName } } = this.props
const { t, routeParams: { splat } } = this.props
return (
<div>
<h1 className="title is-1">
{t('main:menu.help')}: {t(`help:pages.${pageName}`, {defaultValue: "I am lost 😟"})}
{t('main:menu.help')}: {t(`help:pages.${splat}`, {defaultValue: "I am lost 😟"})}
</h1>
<a className="subtitle" onClick={this.props.router.goBack}>
<Icon name="arrow-left"/>
Expand Down
2 changes: 1 addition & 1 deletion app/router.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ ReactDOM.render(
<Route path="/videos/:videoId" component={VideoDebate} view="debate"/>
<Route path="/videos/:videoId/history" component={VideoDebate} view="history"/>
<Route path="/help" component={Help}/>
<Route path="/help/:pageName" component={Help}/>
<Route path="/help/*" component={Help}/>
<Route path="/extension" component={BrowserExtensionsPage}/>
<Route path="*" component={NotFound}/>
</Route>
Expand Down