Giter VIP home page Giter VIP logo

cgeo.github.io's Introduction

c:geo website

This repository contains the website of c:geo. If you are looking for the source code of the c:geo app, please visit github.com/cgeo/cgeo instead.

How to install and run

This site uses Jekyll. In order to test it locally you need a working Ruby environment. See this guide for how to install Ruby on your machine.

Once Ruby is working, install bundler for dependency management.

$ gem install bundler

Then you can cd into the clone of this repository and run bundle install to install all necessary dependencies.

Now you can compile the source and start a local webserver:

$ bundle exec jekyll serve

The site is available at http://localhost:4000.

As there might be changes in the dependencies and development in Jekyll you should run bundle update once in a while to update everything.

Editing the FAQ

The FAQ is located in _data/faq.yml. As you can see this is a YAML file. You do not need to understand the complete syntax, just keep the indentation as it is.

Each FAQ entry uses Markdown (with kramdown extensions) for its content.

Enable a warning

You can enable a warning by adding content to _includes/warning.md (Markdown syntax). It will be shown on the index page (currently only a single, red warning block).

To disable the warning again, insert WARNING_DISABLED somewhere in _includes/warning.md.

cgeo.github.io's People

Contributors

bananeweizen avatar bekuno avatar brainscript avatar brnsystems avatar capoaira avatar fm-sys avatar hauwertlhaufn avatar kumy avatar ldw606 avatar lineflyer avatar mariansam avatar moving-bits avatar mucek4 avatar okainov avatar pstorch avatar rsudev avatar sammyshp avatar samueltardieu avatar shroudedcode avatar technetium avatar tobiasge avatar uniqp avatar valentijnscholten avatar

Stargazers

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

Watchers

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

cgeo.github.io's Issues

Add explanation about needed permissions

On the old homepage we have (had) a brief explanation of why the app needs several permissions on the device (Wake Lock, Internet, Location, etc.).
This should be added as a FAQ entry.

Assigning myself

Include ohloh widget on web page

Moved from cgeo/cgeo#1795

@Bananeweizen:
I suggest to include an ohloh widget on the cgeo home page. I always find that a good way of attracting potential new contributors to a project, if I see it on a web page of another project. It also allows outside people to "judge" the project a little bit (e.g. we currently list 49 contributors which is huge!)
I suggest to use the last one on this page: https://www.ohloh.net/p/cgeo2/widgets

Any comments?

@samueltardieu:
I second this.

@marco-dev:
+1

avoid white background flicker

If you load the website, the background is shortly shown totally white, and after the CSS (or whatever) has been loaded, if switches to black. Can we add a meta tag in the HTML header for black background color to avoid that? (I'm not so much into HTML, so maybe the solution must be something totally different).

I have seen that most prominently on devices where I never loaded the website before (probably because the non existing cached content maximizes the time until the CSS is applied).

searchable FAQ?

I'm wondering if it makes sense to have an input box at the FAQ, which filters all entries down to those which contain a given search string. This would be useful to browse the FAQ from a device and more easily find answers. I've seen this in some support sites, and I found it useful (as device browsers often can an easy to use search, which the desktop browser may have).

Add known limitations to FAQ

On the old index page we had a list of known limitations:

Live map:
Approximated coords due to limitations on the GC-website
Be aware: If navigation is started directly from live map it may also use the approximated coords!
In fast mode the cache type might be wrong in rare cases
Fast mode only detectes Tradi, Multi, Mystery, Event caches
Waypoints on map might disappear when moving the map
(Workaround: Increase waypoint limit in settings)
Other:
Log images with huge size will cause a long loading time

These should be reflected in some FAQ entry. No need to have it on the mainpage.

Assigning myself.

Have a branch for drafts

As the content of master is alyway online it would be helpful to have branch draft for preparation of site changes which e.g. need to be synchronized to a certain release of the app.
While most changes IMHO should go directly to master the draft should be used only for planned updates of the site (e.g. release depending, major rework,etc.)

Would this be a valid method of working with this repo?

Add link to IRC channel

Moved from cgeo/cgeo#2869

@Lineflyer:
Do we want to add an information to our IRC channel to the c:geo website ?
This would allow users to contact us for support via chat.

Most questions on support mail are easy to solve/answer, but for more complicated issues it would be nice to have a direct chat contact.
I don't think that many users would use it however for those with really difficult issues it would be helpful.

Can we add a link on http://www.cgeo.org/contact.html ?
I could also add a link to our FAQ (e.g. "I have a really difficult problem with c:geo. Where to get help?")

@rsudev:
I think it is a good idea to mention our IRC-channel on the website. But I would communcate it as developer channel, not so much as a support forum, because I would like to keep it primarily as our communication medium. This does of course not inhibit to invite anybody into the channel (as we often do already), but offering support their might raise expecations WRT to response times we probably will not fulfill.

@Bananeweizen:
Same opinion as rsudev.

New website release plan

TODO:

Donation link

Of course we should not forget this. I suggest to have it on a static place on each page (like the menu items on the current example).

DO NOT PUSH

I'm preparing the version which uses Jekyll. Please do not push any changes, if it is necessary, I'll overwrite anything here!

Move banners to new website

Currently http://www.cgeo.org/media.html contains some banners.

The hyperlinks for banners promoted there might be used by people and should stay valid after changing to the new website.
If we keep offering them, we should also have a similar page on the new website.

FAQ: Divide "General" into more specific sections

Just a reminder for myself or anyone willing to help:

Once the FAQ has been migrated it could be useful to divide the large section "General" into more appropriate sections like "Compass related", "Logging related", "User interface related" (or alike).

Create FAQ markdown

Once created I volunteer to fill it based on the existing FAQ if it is a markdown file (maybe prefilled with a placeholder to understand the needed markdown syntax).

Just copying might not be enough as some items might be outdated (last general update was done some months ago), so I would like to update while transfering it.

Add Support.html page

This should be added before we release the website.
It should contain a link to our support mail adress and some words about what details we need in order to help (e.g. System information, Detailed error description).

I remember, that I send around a mail with a proposal for an autoresponder for our support mail.
This text should be suitable here as well.
I will try to find it.

@SammysHP If you add the page as a markdown I can volunteer to fill it later on.

Readd c:geo banner pictures to Github

We received some requests about missing banners and logos from our website.
Can't we just put the original content of http://www.cgeo.org/content/ad/ to the very same directory on Github?

IMHO no need to make a HTML page for that, but just to reenable the access to these banners?

different CSS for mobile

The new page looks okay on my mobile. But the page margins could be much smaller. Can we have different CSS for mobile and desktop?

link from features to FAQ

To make people more aware of the FAQ I suggest that we make the feature bullet list (and/or the remaining floating text) link to matching sections of the FAQ.

Collect "did you know" also at the website

I believe that our "did you know" tips on facebook have 2 disadvantages:

  • They only reach facebook people who actively liked the page
  • They cannot easily be re-read later.

Therefore I suggest that similar to the FAQ we create a page that can present these "Did you know" tips. In contrast to the FAQ the presentation of those tricks could use things like a carousel instead of just listing one trick after the other.

FAQ update not possible in play store

I read the question on facebook about not being able to upgrade (due to no upgrade being shown). Actually a friend of mine had the same issue with the March 31 upgrade. I suggest we add a FAQ about rebooting the phone to let the play store sync again, which Lars mentioned as solution.

UI improvements for send2cgeo web

  • "add device" not working as long as the browser is not registered. Maybe remove that part until the browser is registered.
  • "no browser name!" – maybe set during registration?
  • link and text colors are switched
  • not possible to unregister browser (should that be possible?)
  • "change browser name": hint of text input is no hint, user must remove it first

Translate FAQ

I would like to add a german (and other) translations of the FAQ.

This would IMHO only require:

  • A means to select the desired language on the FAQ page or (preferably) auto detect the language from the browsers preference
  • Another yml file for each language using the same anchors

Is this technically possible here on Github?

Link back to page source

Would it be possible to always add a small link to each of our generated pages at the very end (or as an overlay somewhere else), where the URL is the source page on github? E.g. if I see a typo, I would really like to just click that link, afterwards the edit button and start fixing.

Now I always have to search the page in the repo first.

Add Development.html page

As also mentioned in #22 I suggest to have a development page with the following content incl. some basic explanation of these links:

  • Link to Github + optionally ohloh widget
  • Link to Crowdin
  • Link to Nightly Build page (and remove it from the main navigation)
  • Link to IRC developer channel
  • Link to Status page (and remove it from the main navigation)

Advantages:

  • All development related links and ressources on one page
  • Less items in main navigation

remove ! from donation button

For my taste, the exclamation mark is making that a very strong request to donate. But I'd rather like to see that as just an option, not a request.

If I got it right, that button is an image. I'm not that experienced with CSS, but can't that be done by pure CSS without images nowadays?

Layout improvements - Summary

I don't want to create multiple issues as this is basically a summary of my subjective proposals for improvements to the now exiting draft of the new webpage. So I created this tickable list instead which can be later (if agreed) transfered into issues if needed:

  • The header section (with links to different pages) should be shown on each page
  • The header should be static on top (not scrolling together with the content)
  • There has to be a back or home navigation which links back to the index.html
  • We could place the donate button in the same line as the links to GooglePlay, APK Download and give it a similar design.
  • External links (like to Github, etc.) should open in a new window

Have Return-URL after donation is complete

We can customize PayPal to link back to an URL after a donation is completed.
It could be used to show a "Thank you!" page e.g. also explaining for what and what not donations are used.

There are only some minor requirements we have to meet for Paypal:

- Per the user agreement, you must provide verbiage on the page displayed by the Return URL that will help the buyer understand that the payment has been made and that the transaction has been completed.

- You must provide verbiage on the page displayed by the Return URL that explains that payment transaction details will be emailed to the buyer.

- Example: Thank you for your payment. Your transaction has been completed, and a receipt for your purchase has been emailed to you. You may log into your account at www.paypal.com/de to view details of this transaction.

Use Jekyll

Currently we have a single static page. This won't work with our complex content so we should use jekyll, a static page generator that is used for processing GitHub user pages.

Remove Nightly and Status from Main Navigation

Those items are now included on development.html.

I did not yet remove anything as I wanted to wait for feedback first.
Especially the nightlies might become harder to find if they are removed, so I am not sure about that.

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.