====== Wikidoc ======

The Wikidoc project was invented to overcome psychological barrier of additional actions required to write and maintain documentation.

It is based on system of aliases that notify wikidoc server about context the user is in. A wikidoc window would then allow on-the-spot editing of documentation associated with the context.

===== Normal wiki pages =====

Besides serving as Wiki pages storage, the wiki contains other information pieces. The only way to find them is using search by keywords. So please think carefully about which keywords the next guy is going to use to find your page.

You can start by reading list of existing [[https://f1xwiki.catchmedia.com/doku.php?id=start&do=index|page names]].

===== What is context =====

Context tag is string that uniquely defines activity the user is doing at the moment. It might be server/path the user is currently in. Later on we can use other means to identify the activity (screen OCR, F1x-aware apps/breadcrumbs, inotify on files being opened, etc).

The "context switch" then causes associated documentation to show up in wikidoc help window, enabling user to view or edit it.

===== Examples of context ID =====

  * Get into directory of a server: ``CHDIR|hungama-ingestion:/opt/tmp_14days``
  * ssh into a server: ``SERVER:bas1``
  * execute a command: ``CMD:dap2:/opt/mysql_reports_sdemo:dcmy``

===== Contexts Documentation Storage =====

Piece of documentation for a context is called "Wikidoc memo".

Initially wikidoc memos are stored in the dokuwiki, as stepping stone on a path to full-fledged F1x memos store. Backend dokuwiki engine provides important out-of-the-box capabilities, such as authentication, using browser to edit wikidoc memos, builtin markup language, search.

wikidoc memo reference has format "wikidoc:COMPANY:Level1,Level2…", case insensitive.

===== Wikidoc backend and frontend =====

During POC, frontend is JS-enabled website window that user can switch to easily (for example using F1 button). It has functions below:

  * Authenticate users
  * Receive updates from Backend about context switches
  * Open wiki page for given context in iframe

Backend receives context switches from "agents" and sends them to corresponding Frontend session.

[[:f1x:wikidoc:frontend:future_ideas|Ideas on Frontend improvement]]

===== Context switch collection =====

==== ssh ====

F1x backend must be aware about context switches of many users so to send appropriate messages to F1x frontend. For ssh sessions and commands we employ scheme below:

  - User does ssh into master using his username. Script .bashrc defines LC_F1USER environment variable
  - ssh command is actually alias that sens environment variable LC_F1USER along, like this:
<code>

export LC_F1USER=skliarie@gmail.com; ssh root@bas1.catchmedia.com -o SendEnv=LC_F1USER

</code>

  - The environment variable becomes visible on the target server, thanks to allowance in sshd_config for all LC_* vars:

<code>
root@bas1:~# grep LC_ /etc/ssh/sshd_config
AcceptEnv LANG LC_*

</code>

  - .bashrc script creates /tmp/f1x/tmp/PID file with content of $LC_F1USER. F1daemon watches the directory (using inotify) on tries to figure out the context, using /proc/$$/cwd symlink, pstree and other heuristics.
  - Successfully recognized context switches are sent to backend (using redis-ops pubsub for now)

==== browser ====

There might be browser add-on, that will detect [[https://stackoverflow.com/questions/11594576/getting-current-browser-url-in-firefox-addon|newly opened URLs]] and report them to F1x server for analysis and possible context matching.

==== native apps ====

//The feature is for startup-stage//. A native desktop agent identifies contexts in native apps based on various heuristics and reports them to F1x server for analysis and possible context matching.