From ac767295a1476118f40c8f87b5e8846488835bb9 Mon Sep 17 00:00:00 2001 From: les Date: Sat, 21 Sep 2019 23:26:21 +0200 Subject: [PATCH] add forum link to docs --- docs/_config.yml | 6 +- docs/_site/404.html | 18 +- docs/_site/assets/js/just-the-docs.js | 201 +++++++++--------- docs/_site/assets/js/search-data.json | 15 +- docs/_site/config.html | 18 +- docs/_site/dev.html | 24 ++- docs/_site/dev/locales.html | 288 ++++++++++++++++++++++++++ docs/_site/dev/migration.html | 18 +- docs/_site/dev/structure.html | 18 +- docs/_site/feed.xml | 2 +- docs/_site/index.html | 18 +- docs/_site/install.html | 18 +- docs/_site/install/debian.html | 18 +- docs/_site/install/docker.html | 18 +- docs/_site/install/nginx.html | 18 +- docs/_site/instances.html | 18 +- docs/dev/locales.md | 9 + pages/admin.vue | 2 + 18 files changed, 610 insertions(+), 117 deletions(-) create mode 100644 docs/_site/dev/locales.html create mode 100644 docs/dev/locales.md diff --git a/docs/_config.yml b/docs/_config.yml index 1f3286d9..a2ce2e05 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -34,7 +34,11 @@ search_enabled: true aux_links: "Source": - - https://framagit.org/les/gancio + - https://framagit.org/les/gancio + "Forum": + - https://framavox.org/g/hMXTDgtJ/gancio + + #Exclude from processing. diff --git a/docs/_site/404.html b/docs/_site/404.html index 9168c1f9..910a1fe7 100644 --- a/docs/_site/404.html +++ b/docs/_site/404.html @@ -78,6 +78,10 @@ + + + + @@ -121,6 +125,8 @@ + +
  • Nginx @@ -172,6 +178,14 @@ +
  • + + Support a new language + +
    • + + +
  • Migration @@ -238,7 +252,9 @@ diff --git a/docs/_site/assets/js/just-the-docs.js b/docs/_site/assets/js/just-the-docs.js index f7fee8c4..b3fca27a 100644 --- a/docs/_site/assets/js/just-the-docs.js +++ b/docs/_site/assets/js/just-the-docs.js @@ -1,175 +1,176 @@ // Event handling -function addEvent (el, type, handler) { - if (el.attachEvent) { el.attachEvent('on' + type, handler) } else { el.addEventListener(type, handler) } +function addEvent(el, type, handler) { + if (el.attachEvent) el.attachEvent('on'+type, handler); else el.addEventListener(type, handler); } -function removeEvent (el, type, handler) { - if (el.detachEvent) { el.detachEvent('on' + type, handler) } else { el.removeEventListener(type, handler) } +function removeEvent(el, type, handler) { + if (el.detachEvent) el.detachEvent('on'+type, handler); else el.removeEventListener(type, handler); } // Show/hide mobile menu -function toggleNav () { - const nav = document.querySelector('.js-main-nav') - const auxNav = document.querySelector('.js-aux-nav') - const navTrigger = document.querySelector('.js-main-nav-trigger') - const search = document.querySelector('.js-search') +function toggleNav(){ + const nav = document.querySelector('.js-main-nav'); + const auxNav = document.querySelector('.js-aux-nav'); + const navTrigger = document.querySelector('.js-main-nav-trigger'); + const search = document.querySelector('.js-search'); - addEvent(navTrigger, 'click', function () { - const text = navTrigger.textContent - let textToggle = navTrigger.getAttribute('data-text-toggle') + addEvent(navTrigger, 'click', function(){ + var text = navTrigger.innerText; + var textToggle = navTrigger.getAttribute('data-text-toggle'); - nav.classList.toggle('nav-open') - auxNav.classList.toggle('nav-open') - navTrigger.classList.toggle('nav-open') - search.classList.toggle('nav-open') - navTrigger.textContent = textToggle - navTrigger.setAttribute('data-text-toggle', text) - textToggle = text + nav.classList.toggle('nav-open'); + auxNav.classList.toggle('nav-open'); + navTrigger.classList.toggle('nav-open'); + search.classList.toggle('nav-open'); + navTrigger.innerText = textToggle; + navTrigger.setAttribute('data-text-toggle', text); + textToggle = text; }) } // Site search -function initSearch () { - const index = lunr(function () { - this.ref('id') - this.field('title', { boost: 20 }) - this.field('content', { boost: 10 }) - this.field('url') - }) +function initSearch() { + var index = lunr(function () { + this.ref('id'); + this.field('title', { boost: 20 }); + this.field('content', { boost: 10 }); + this.field('url'); + }); // Get the generated search_data.json file so lunr.js can search it locally. - sc = document.getElementsByTagName('script') - source = '' + sc = document.getElementsByTagName("script"); + source = ''; - for (idx = 0; idx < sc.length; idx++) { - s = sc.item(idx) + for(idx = 0; idx < sc.length; idx++) + { + s = sc.item(idx); - if (s.src && s.src.match(/just-the-docs\.js$/)) { source = s.src } + if(s.src && s.src.match(/just-the-docs\.js$/)) + { source = s.src; } } - jsPath = source.replace('just-the-docs.js', '') + jsPath = source.replace('just-the-docs.js', ''); - jsonPath = jsPath + 'search-data.json' + jsonPath = jsPath + 'search-data.json'; - const request = new XMLHttpRequest() - request.open('GET', jsonPath, true) + var request = new XMLHttpRequest(); + request.open('GET', jsonPath, true); - request.onload = function () { + request.onload = function() { if (request.status >= 200 && request.status < 400) { // Success! - const data = JSON.parse(request.responseText) - const keys = Object.keys(data) + var data = JSON.parse(request.responseText); + var keys = Object.keys(data); - for (const i in data) { + for(var i in data) { index.add({ id: data[i].id, title: data[i].title, content: data[i].content, url: data[i].url - }) + }); } - searchResults(data) + searchResults(data); } else { // We reached our target server, but it returned an error - console.log('Error loading ajax request. Request status:' + request.status) + console.log('Error loading ajax request. Request status:' + request.status); } - } + }; - request.onerror = function () { + request.onerror = function() { // There was a connection error of some sort - console.log('There was a connection error') - } + console.log('There was a connection error'); + }; - request.send() + request.send(); - function searchResults (dataStore) { - const searchInput = document.querySelector('.js-search-input') - const searchResults = document.querySelector('.js-search-results') - const store = dataStore + function searchResults(dataStore) { + var searchInput = document.querySelector('.js-search-input'); + var searchResults = document.querySelector('.js-search-results'); + var store = dataStore; - function hideResults () { - searchResults.innerHTML = '' - searchResults.classList.remove('active') + function hideResults() { + searchResults.innerHTML = ''; + searchResults.classList.remove('active'); } - addEvent(searchInput, 'keyup', function (e) { - const query = this.value + addEvent(searchInput, 'keyup', function(e){ + var query = this.value; - searchResults.innerHTML = '' - searchResults.classList.remove('active') + searchResults.innerHTML = ''; + searchResults.classList.remove('active'); if (query === '') { - hideResults() + hideResults(); } else { - const results = index.search(query) + var results = index.search(query); if (results.length > 0) { - searchResults.classList.add('active') - const resultsList = document.createElement('ul') - searchResults.appendChild(resultsList) + searchResults.classList.add('active'); + var resultsList = document.createElement('ul'); + searchResults.appendChild(resultsList); - for (const i in results) { - const resultsListItem = document.createElement('li') - const resultsLink = document.createElement('a') - const resultsUrlDesc = document.createElement('span') - const resultsUrl = store[results[i].ref].url - const resultsRelUrl = store[results[i].ref].relUrl - const resultsTitle = store[results[i].ref].title + for (var i in results) { + var resultsListItem = document.createElement('li'); + var resultsLink = document.createElement('a'); + var resultsUrlDesc = document.createElement('span'); + var resultsUrl = store[results[i].ref].url; + var resultsRelUrl = store[results[i].ref].relUrl; + var resultsTitle = store[results[i].ref].title; - resultsLink.setAttribute('href', resultsUrl) - resultsLink.textContent = resultsTitle - resultsUrlDesc.textContent = resultsRelUrl + resultsLink.setAttribute('href', resultsUrl); + resultsLink.innerText = resultsTitle; + resultsUrlDesc.innerText = resultsRelUrl; - resultsList.classList.add('search-results-list') - resultsListItem.classList.add('search-results-list-item') - resultsLink.classList.add('search-results-link') - resultsUrlDesc.classList.add('fs-2', 'text-grey-dk-000', 'd-block') + resultsList.classList.add('search-results-list'); + resultsListItem.classList.add('search-results-list-item'); + resultsLink.classList.add('search-results-link'); + resultsUrlDesc.classList.add('fs-2','text-grey-dk-000','d-block'); - resultsList.appendChild(resultsListItem) - resultsListItem.appendChild(resultsLink) - resultsLink.appendChild(resultsUrlDesc) + resultsList.appendChild(resultsListItem); + resultsListItem.appendChild(resultsLink); + resultsLink.appendChild(resultsUrlDesc); } } // When esc key is pressed, hide the results and clear the field if (e.keyCode == 27) { - hideResults() - searchInput.value = '' + hideResults(); + searchInput.value = ''; } } - }) + }); - addEvent(searchInput, 'blur', function () { - setTimeout(function () { hideResults() }, 300) - }) + addEvent(searchInput, 'blur', function(){ + setTimeout(function(){ hideResults() }, 300); + }); } } -function pageFocus () { - const mainContent = document.querySelector('.js-main-content') - mainContent.focus() +function pageFocus() { + var mainContent = document.querySelector('.js-main-content'); + mainContent.focus(); } + // Document ready -function ready () { - toggleNav() - pageFocus() +function ready(){ + toggleNav(); + pageFocus(); if (typeof lunr !== 'undefined') { - initSearch() + initSearch(); } } // in case the document is already rendered -if (document.readyState != 'loading') { ready() } +if (document.readyState!='loading') ready(); // modern browsers -else if (document.addEventListener) { document.addEventListener('DOMContentLoaded', ready) } +else if (document.addEventListener) document.addEventListener('DOMContentLoaded', ready); // IE <= 8 -else { - document.attachEvent('onreadystatechange', function () { - if (document.readyState == 'complete') { ready() } - }) -} +else document.attachEvent('onreadystatechange', function(){ + if (document.readyState=='complete') ready(); +}); diff --git a/docs/_site/assets/js/search-data.json b/docs/_site/assets/js/search-data.json index 26c0ba77..d3c51071 100644 --- a/docs/_site/assets/js/search-data.json +++ b/docs/_site/assets/js/search-data.json @@ -57,20 +57,27 @@ }, "8": { "id": "8", + "title": "Support a new language", + "content": "Add a new locale watch this commit https://framagit.org/les/gancio/commit/cd95c7eb3b9e4bc4832a7b33d8d79b4fd3cbda2d", + "url": "https://gancio.org/dev/locales", + "relUrl": "/dev/locales" + }, + "9": { + "id": "9", "title": "Migration", "content": "Migration If you need to modify the db’s structure while hacking, it’s super easy, just change server/api/models/. If you then decide that your changes are good for production, a sequelize migration is needed: Create a migration: ./node_modules/.bin/sequelize migration:generate --name your_migration", "url": "https://gancio.org/dev/migration", "relUrl": "/dev/migration" }, - "9": { - "id": "9", + "10": { + "id": "10", "title": "Nginx", "content": "Nginx proxy configuration This is the default nginx configuration for gancio, please modify at least the server_name and ssl_certificate’s path. Note that this does not include a cache configuration and that gancio does not use a cache control at all, if you can help with this task you’re welcome. server { listen 80; listen [::]:80; server_name gancio.cisti.org; root /var/www/letsencrypt; location /.well-known/acme-challenge/ { allow all; } location / { return 301 https://$host$request_uri; } } server { listen 443 ssl http2; listen [::]:443 ssl http2; server_name gancio.cisti.org; ssl_protocols TLSv1.2; ssl_ciphers HIGH:!MEDIUM:!LOW:!aNULL:!NULL:!SHA; ssl_prefer_server_ciphers on; ssl_session_cache shared:SSL:10m; # Uncomment these lines once you acquire a certificate: # ssl_certificate /etc/letsencrypt/live/gancio.cisti.org/fullchain.pem; # ssl_certificate_key /etc/letsencrypt/live/gancio.cisti.org/privkey.pem; keepalive_timeout 70; sendfile on; client_max_body_size 80m; gzip on; gzip_disable "msie6"; gzip_vary on; gzip_proxied any; gzip_comp_level 6; gzip_buffers 16 8k; gzip_http_version 1.1; gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript; add_header Strict-Transport-Security "max-age=31536000"; location / { try_files $uri @proxy; } location @proxy { proxy_set_header Host $host; proxy_set_header X-Forwarded-Proto https; proxy_set_header Proxy ""; proxy_pass_header Server; proxy_pass http://127.0.0.1:13120; proxy_buffering on; proxy_redirect off; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection $connection_upgrade; tcp_nodelay on; } }", "url": "https://gancio.org/install/nginx", "relUrl": "/install/nginx" }, - "10": { - "id": "10", + "11": { + "id": "11", "title": "Project Structure", "content": "Project structure API / backend Client / frontend Federation / ActivityPub API / backend Source code inside server/api/. index.js is basically a routing table pointing each PATH with specified HTTP VERB to a method of a controller. jwt is used to authenticate api request. Express.js is based on middleware, passing each request to a chain of methods. If you come from a PHP background, note that the main difference with Node.js is that the server process is always running and able to manage multiple requests and tasks together (asyncronically) while each php process is tied to a single request. Sequelize is used as ORM. Take a look in /server/api/models. Client / frontend Nuxt.js is used here! Nuxt is basically Vue plus SSR (Server Side Rendering). Client routing in nuxt is automatic (if you don’t need something special), just put your page inside pages and that’s it! Federation / ActivityPub Code inside server/federation.", "url": "https://gancio.org/dev/structure", diff --git a/docs/_site/config.html b/docs/_site/config.html index 12aebc08..987be947 100644 --- a/docs/_site/config.html +++ b/docs/_site/config.html @@ -78,6 +78,10 @@ + + + + @@ -121,6 +125,8 @@ + +
  • Nginx @@ -172,6 +178,14 @@ +
  • + + Support a new language + +
    • + + +
  • Migration @@ -239,7 +253,9 @@ diff --git a/docs/_site/dev.html b/docs/_site/dev.html index cf290c7e..bac564ae 100644 --- a/docs/_site/dev.html +++ b/docs/_site/dev.html @@ -78,6 +78,10 @@ + + + + @@ -121,6 +125,8 @@ + +
  • Nginx @@ -172,6 +178,14 @@ +
  • + + Support a new language + +
    • + + +
  • Migration @@ -238,7 +252,9 @@ @@ -293,6 +309,12 @@ +
  • + Support a new language +
    • + + +
  • Migration
    • diff --git a/docs/_site/dev/locales.html b/docs/_site/dev/locales.html new file mode 100644 index 00000000..a50c5a55 --- /dev/null +++ b/docs/_site/dev/locales.html @@ -0,0 +1,288 @@ + + + + + + + + Support a new language - Gancio + + + + + + + + + + + + + + + + + + + +Support a new language | Gancio + + + + + + + + + + + + + + + +
    +
    + Gancio + +
    + + +
    +
    +

    This site uses Just the Docs, a documentation theme for Jekyll.

    +
    +
    +
    +
    +
    + +
    +
    + + Search +
    +
    +
    + + + + +
    +
    +
    + + + + + +
    +

    Add a new locale

    +

    watch this commit https://framagit.org/les/gancio/commit/cd95c7eb3b9e4bc4832a7b33d8d79b4fd3cbda2d

    + + + +
    +
    +
    +
    + + + diff --git a/docs/_site/dev/migration.html b/docs/_site/dev/migration.html index c1a4fd48..e4caa6e8 100644 --- a/docs/_site/dev/migration.html +++ b/docs/_site/dev/migration.html @@ -78,6 +78,10 @@ + + + + @@ -121,6 +125,8 @@ + +
  • Nginx @@ -172,6 +178,14 @@ +
  • + + Support a new language + +
    • + + +
  • Migration @@ -238,7 +252,9 @@ diff --git a/docs/_site/dev/structure.html b/docs/_site/dev/structure.html index 0c131291..a48e4dad 100644 --- a/docs/_site/dev/structure.html +++ b/docs/_site/dev/structure.html @@ -78,6 +78,10 @@ + + + + @@ -121,6 +125,8 @@ + +
  • Nginx @@ -172,6 +178,14 @@ +
  • + + Support a new language + +
    • + + +
  • Migration @@ -238,7 +252,9 @@ diff --git a/docs/_site/feed.xml b/docs/_site/feed.xml index a6c0b4bb..d6ebe32f 100644 --- a/docs/_site/feed.xml +++ b/docs/_site/feed.xml @@ -1 +1 @@ -Jekyll2019-08-31T22:50:30+02:00https://gancio.org/feed.xmlGancioA shared agenda for local communities \ No newline at end of file +Jekyll2019-09-21T23:24:31+02:00https://gancio.org/feed.xmlGancioA shared agenda for local communities \ No newline at end of file diff --git a/docs/_site/index.html b/docs/_site/index.html index 4877f7f3..556d1d91 100644 --- a/docs/_site/index.html +++ b/docs/_site/index.html @@ -80,6 +80,10 @@ + + + + @@ -123,6 +127,8 @@ + +
  • Nginx @@ -174,6 +180,14 @@ +
  • + + Support a new language + +
    • + + +
  • Migration @@ -241,7 +255,9 @@ diff --git a/docs/_site/install.html b/docs/_site/install.html index 6ffa8aa2..fee04f41 100644 --- a/docs/_site/install.html +++ b/docs/_site/install.html @@ -78,6 +78,10 @@ + + + + @@ -121,6 +125,8 @@ + +
  • Nginx @@ -172,6 +178,14 @@ +
  • + + Support a new language + +
    • + + +
  • Migration @@ -238,7 +252,9 @@ diff --git a/docs/_site/install/debian.html b/docs/_site/install/debian.html index 9e086bc5..14b7f56f 100644 --- a/docs/_site/install/debian.html +++ b/docs/_site/install/debian.html @@ -78,6 +78,10 @@ + + + + @@ -121,6 +125,8 @@ + +
  • Nginx @@ -172,6 +178,14 @@ +
  • + + Support a new language + +
    • + + +
  • Migration @@ -238,7 +252,9 @@ diff --git a/docs/_site/install/docker.html b/docs/_site/install/docker.html index 4e339020..885fb68b 100644 --- a/docs/_site/install/docker.html +++ b/docs/_site/install/docker.html @@ -78,6 +78,10 @@ + + + + @@ -121,6 +125,8 @@ + +
  • Nginx @@ -172,6 +178,14 @@ +
  • + + Support a new language + +
    • + + +
  • Migration @@ -239,7 +253,9 @@ diff --git a/docs/_site/install/nginx.html b/docs/_site/install/nginx.html index 4c1ca90d..9029bb1e 100644 --- a/docs/_site/install/nginx.html +++ b/docs/_site/install/nginx.html @@ -78,6 +78,10 @@ + + + + @@ -121,6 +125,8 @@ + +
  • Nginx @@ -172,6 +178,14 @@ +
  • + + Support a new language + +
    • + + +
  • Migration @@ -238,7 +252,9 @@ diff --git a/docs/_site/instances.html b/docs/_site/instances.html index 4a6e18a1..d98da239 100644 --- a/docs/_site/instances.html +++ b/docs/_site/instances.html @@ -78,6 +78,10 @@ + + + + @@ -121,6 +125,8 @@ + +
  • Nginx @@ -172,6 +178,14 @@ +
  • + + Support a new language + +
    • + + +
  • Migration @@ -238,7 +252,9 @@ diff --git a/docs/dev/locales.md b/docs/dev/locales.md new file mode 100644 index 00000000..7110c02a --- /dev/null +++ b/docs/dev/locales.md @@ -0,0 +1,9 @@ +--- +layout: default +title: Support a new language +permalink: /dev/locales +parent: Hacking +--- + +### Add a new locale +watch this commit https://framagit.org/les/gancio/commit/cd95c7eb3b9e4bc4832a7b33d8d79b4fd3cbda2d \ No newline at end of file diff --git a/pages/admin.vue b/pages/admin.vue index 801ab4ac..daf46ff1 100644 --- a/pages/admin.vue +++ b/pages/admin.vue @@ -68,6 +68,8 @@ //- el-form-item(:label="$t('admin.allow_boost_like')") //- el-switch(v-model='allow_comments') + //- el-tab-pane.pt-1 +