Merge pull request #315 from presslabs/hugo62

vtemian · web-flow · commit fd3ed402b291 · 2020-01-23T14:08:50.000+02:00
Update documentaion structure and syntax
diff --git a/docs/_index.md b/docs/_index.md
@@ -2,9 +2,32 @@
 title: What is Gitfs
 linktitle: What is Gitfs
 description: Gitfs is a fuse file system that fully integrates with git
-categories: [gitfs]
 keywords: [gitfs, versioned filesystem, git filesystem, fuse, linux filesystem, macos filesystem]
-toc: false
-related: false
-layout: documentation-home
 ---
+
+## Welcome to gitfs
+
+gitfs is a [FUSE](http://fuse.sourceforge.net/) file system that fully integrates with git. You can mount a remote repository’s branch locally, and any subsequent changes made to the files will be automatically committed to the remote.
+
+## What’s its purpose?
+
+gitfs was designed to bring the full powers of git to everyone, irrespective of their experience using the tool. You can mount any repository, and all the changes you make will be automatically converted into commits. gitfs will also expose the history of the branch you’re currently working on by simulating snapshots of every commit.
+
+gitfs is useful in places where you want to keep track of all your files, but at the same time you don’t have the possibility of organizing everything into commits yourself. A FUSE file system for git repositories, with local cache.
+
+## Features
+
+- Automatically commits changes: create, delete, update files and their metadata
+- Browse through working index and commit history
+- Merges with upstream by automatically accepting local changes
+- Mounts the file system as a user or a group
+- Caching commits reduces the memory footprint and speeds up navigation
+- Reduces the number of commits by grouping pushes
+
+## Development
+
+You are highly encouraged to use gitfs, to contribute with code, tests, documentation, or just to share your experience. Development of gitfs happens at [github.com/Presslabs/gitfs](https://github.com/Presslabs/gitfs). The concise contribution guide can be found in the [CONTRIBUTING.md](https://github.com/Presslabs/gitfs/blob/master/CONTRIBUTING.md) file.
+
+## License
+
+This project is licensed under the Apache 2.0 license. Have a look at the [LICENSE](https://github.com/Presslabs/gitfs/blob/master/LICENSE) file in the top distribution directory for the complete, unabridged reference.
diff --git a/docs/arguments.md b/docs/arguments.md
@@ -2,14 +2,10 @@
 title: Arguments
 linktitle: Arguments
 description: A list with all arguments for Gitfs
-categories: [gitfs]
 keywords: [gitfs, arguments, usage]
-weight: 4
-draft: false
-aliases: []
-toc: true
-related: true
-slug: arguments
+menu:
+  global:
+    weight: 3
 ---
 
 ## Using options
@@ -20,7 +16,7 @@ In order to use options when mounting gitfs, you need to append the options as a
 -o option1=value1,option2=value2,option3=value3...
 ```
 
-### All available options
+## All available options
 
 | **Name**             | **Default**                | **Description**                                                                                                                                                                                                                                                                                                       |
 |----------------------|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
diff --git a/docs/config.toml b/docs/config.toml
@@ -1,92 +1,29 @@
-baseURL = "https://www.presslabs.com/code/gitfs/"
-languageCode = "en-us"
-title = "Gitfs DOCS"
-summaryLength = 15
-metaDataFormat = "yaml"
-theme = "docs"
-enableRobotsTXT = true
-enableGitInfo = true
+baseURL = "https://www.presslabs.com/docs/code/gitfs"
 pygmentsCodeFences = true
-pygmentsOptions = ""
+pygmentsCodeFencesGuessSyntax = true
 pygmentsUseClasses = true
-pygmentsUseClassic = false
-pygmentsStyle = "github"
-dataDir = "/site/data"
+theme = "hugo-docs-theme"
+languageCode = "en-us"
+title = "Gitfs DOCS"
+
+[markup]
+  defaultMarkdownHandler = "goldmark"
 
 [params]
-  site_url = "https://www.presslabs.com/code/"
-  legal_url = "https://www.presslabs.com/legal"
-  breadcrumbs_root = "Gitfs DOCS"
-  quick_start = true
-  quick_start_link = "what-is-gitfs/"
+  related = true
   logo_text = "CODE"
-  search_placeholder = "Search code"
-  footer_menu = true
-  footer_menu_title = "DOCUMENTATION"
-  title = "Welcome to Gitfs Documentation!"
-  description = "Gitfs is a fuse filesystem that fully integrates with git"
-  release = "0.5.1"
-  # debug = true
-  algolia_search = true
-  algolia_appId = "0TS6NFHDBC"
-  algolia_apiKey = "099bffdf3b4a6ea94ddbea10f73dd15a"
-  algolia_indexName = "Gitfs Docs"
-  algolia_currentLanguageOnly = true
-  images = ["images/code.jpg"]
+  versions = false
 
 [params.algolia]
-  vars = ["title", "description", "summary", "content", "date", "lastmod", "permalink", "text", "lvl0", "lvl1", "url"]
-  params = ["categories", "keywords"]
-
-[blackfriday]
-  angledQuotes = true
-  extensions = ["hardLineBreak"]
-  sourceRelativeLinks = true
-  fractions = false
-  plainIDAnchors = true
-
-[outputFormats.Algolia]
-  baseName = "algolia"
-  isPlainText = true
-  mediaType = "application/json"
-  notAlternative = true
+  appId = "0TS6NFHDBC"
+  apiKey = "b2efcfd6516eed7a2f19269f9cb13acb"
+  indexName = "Gitfs Docs"
+  vars = ["title", "description", "content", "date", "lastmod", "permalink", "text", "lvl0", "lvl1", "url"]
 
 [outputs]
-  home = [ "HTML", "RSS", "JSON", "Algolia" ]
-
-[taxonomies]
-  category = "categories"
+  home = [ "HTML", "RSS", "JSON" ]
 
 [related]
   threshold = 80
   includeNewer = true
   toLower = false
-
-[[related.indices]]
-  name = "keywords"
-  weight = 150
-
-[[menu.docs]]
-  name = "What is Gitfs"
-  weight = 1
-  url = "/what-is-gitfs/"
-
-[[menu.docs]]
-  name = "How it works"
-  weight = 2
-  url = "/how-gitfs-works/"
-
-[[menu.docs]]
-  name = "Usage"
-  weight = 3
-  url = "/install-and-use-gitfs/"
-
-[[menu.docs]]
-  name = "Arguments"
-  weight = 4
-  url = "/arguments/"
-
-[imaging]
-  resampleFilter = "CatmullRom"
-  quality = 75
-  anchor = "smart"
diff --git a/docs/how-it-works.md b/docs/how-it-works.md
@@ -2,29 +2,25 @@
 title: How Gitfs works
 linktitle: Gitfs explained
 description: Gitfs uses fuse to create current and history directories
-categories: [gitfs]
 keywords: [gitfs, readonlyview, passthroughview, currentview, historyview, commitview, indexview, fetchworker, mergeworker]
-weight: 2
-draft: false
-aliases: []
-toc: true
-related: true
-slug: how-gitfs-works
+menu:
+  global:
+    weight: 1
 ---
 
 ## FUSE
 
 gitfs uses [FUSE](http://fuse.sourceforge.net/) to create its filesystem. It’s used to create the `current` and `history` directories that you can find where you mounted the repository. More on that [here](usage.md#user-content-directory-structure).
 
-### pygit2
+## pygit2
 
 [pygit2](https://github.com/libgit2/pygit2) gives us direct access to git and makes room for a lot of optimization. The alternative, using shell commands, would have been a pain to implement and so would have been tying it to a state too.
 
-### Structure
-This is a simplified overview of the `gitfs` structure.
+## Structure
 
-### Class diagram
+This is a simplified overview of the `gitfs` structure.
 
+## Class diagram
 
 ### Router
 
diff --git a/docs/usage.md b/docs/usage.md
@@ -2,14 +2,11 @@
 title: How to install and use Gitfs
 linktitle: Install Gitfs
 description: Here are the required steps to install and use Gitfs on your machine.
-categories: [gitfs]
 keywords: [gitfs, install gitfs, install on ubuntu 18.04, install on ubuntu 19.04, gitfs on ubuntu, gitfs on debian, gitfs on macos]
-weight: 3
-draft: false
-aliases: []
-toc: true
-related: true
-slug: install-and-use-gitfs
+menu:
+  global:
+    weight: 2
+alias: install-and-use-gitfs
 ---
 
 ## Installing
@@ -48,7 +45,8 @@ In order to mount your repository to the desired directory, use:
 ```
 gitfs http://your.com/repository.git /mount/directory
 ```
-#### Full github example
+### Full github example
+
 Consider the following setup:
 - apache2 running as `www-data` user/group
 - `foo_user` - your username at github.com
@@ -61,13 +59,17 @@ Before mounting your repo, run once these two commands:
 
 Now it's time for test run:
 
-`gitfs -o log=/var/log/gitfs.log,debug=true,foreground=true,commiter_name=foo_user,commiter_email=foo_user@whatever.com,user=www-data,group=www-data,username=foo_user,password=boo_password https://github.com/foo_user/my_git_project.git /var/mount/whatever_dir`
+```
+gitfs -o log=/var/log/gitfs.log,debug=true,foreground=true,commiter_name=foo_user,commiter_email=foo_user@whatever.com,user=www-data,group=www-data,username=foo_user,password=boo_password https://github.com/foo_user/my_git_project.git /var/mount/whatever_dir
+```
 
-Open second terminal window and monitor the log file via command `tail -f /var/log/gitfs.log`. Play around with files in your dir and see how it reflects in your repository at github, make sure that it works in both directions. Use Ctrl-C to stop gitfs when you are done. 
+Open second terminal window and monitor the log file via command `tail -f /var/log/gitfs.log`. Play around with files in your dir and see how it reflects in your repository at github, make sure that it works in both directions. Use Ctrl-C to stop gitfs when you are done.
 
 For production use the following arguments:
 
-`gitfs -o log=/var/log/gitfs.log,debug=false,foreground=false,log_level=warning,commiter_name=foo_user,commiter_email=foo_user@whatever.com,user=www-data,group=www-data,username=foo_user,password=boo_password https://github.com/foo_user/my_git_project.git /var/mount/whatever_dir`
+```
+gitfs -o log=/var/log/gitfs.log,debug=false,foreground=false,log_level=warning,commiter_name=foo_user,commiter_email=foo_user@whatever.com,user=www-data,group=www-data,username=foo_user,password=boo_password https://github.com/foo_user/my_git_project.git /var/mount/whatever_dir
+```
 
 See [Arguments](arguments.md) for more details.
 
@@ -101,5 +103,4 @@ The inner folders are the snapshots of their respective commits.
 
 `gitfs` automatically fetches the newest changes from your repository at a given time interval. The default delay between fetches is `30s` but you can change this value with the `fetch_delay` argument. See [Arguments](arguments.md) for more details.
 
-
 The inner folders are the snapshots of their respective commits.
diff --git a/docs/what-is-gitfs.md b/docs/what-is-gitfs.md
