jekyll-theme-alta-docs 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8ca9cda661b8b01ab6a7275ffd600d739ea8b6c8483ef8e143a5846d8f21204
-  data.tar.gz: ef74fbed8ff07421c6188a96b61d905eedba9e1d85b1a6577e3d6fc845b7f89b
+  metadata.gz: cfe209fc6b38de2a86aa011b9b6c4ca07563e9da0f92fb0a0a0940d1bb2135f0
+  data.tar.gz: 52ef29832776dc1a37f4eb2692a1d0d83ea996c6cbfc91cfa65aaa9fca400558
 SHA512:
-  metadata.gz: b7c287dfd11f48a8e5c7b60c5fe5fb00b45a2b4994b8c62626165f8801e10770a192097a9b6440f745a1260152262ac768037297551aba7073c6fe7879ae013f
-  data.tar.gz: 7491feddd407aaa43db35a403fab548aff2ca9dea1fbc290d0823f66827ab80b947c3d87e30aaaae4eb9cfa6131ebe66bc51276365abf4e29f3d37feeb39e858
+  metadata.gz: 63ad959b450234ac1911d30e5004acf5ec0b66b3ccf9e527897bbbf137fcdf876510fb1526fd98d0b37eecd9fa82124d0fe4d4152cf14f4aac362b79263133ad
+  data.tar.gz: aa20a00e02103dffe3ba40d0b16a548e3b733228fd1d8976853dad8eb15a011cf2aa2ccd324f35043c2923c2c2dd89ea1d9a172391e2514a8c0fd8aa18559c4f

data/README.md

@@ -79,114 +79,27 @@ The Jekyll theme for documenting software development projects.
 
         This is my home page
 
-7. Run:
-
-        bundle exec jekyll serve
-
-### What's next?
-
-Add more documents in *_docs* folder and see [advanced options](#advanced-options).
-
-
-## Advanced options
-
-### Common _config.yml options
-
-        title             : "Project title"
-
-        getting_started   : >-    # Used in the Project overview component
-          Take a look on the useful materials below.
-          Start by checking "the System Overview" to get a big picture of the project.
-          Don't forget to check "Development Guidelines".
-          Find more by exploring navigation on the left.
-
-
-
-### Links
-
-Links to the repositories can be added in *_config.yml*:
-
-        links:
-          repos:
-            - name  : Web app repository
-              icon  : "fab fa-github" # Use fontawesome v6
-              url   : https://bitbucket.org/
-            - name  : Backend repository
-              icon  : "fab fa-bitbucket" # Use fontawesome v6
-              url   : https://bitbucket.org/
-            - name  : Docs repository
-              icon  : "fab fa-gitlab" # Use fontawesome v6
-              url   : https://bitbucket.org/
-          useful:
-            - name  : System overview
-              icon  : "fas fa-project-diagram"
-              url   : /architecture/
-            - name  : Architecture
-              icon  : "fas fa-clipboard-list"
-              url   : /architecture/
-            - name  : Development Guidelines
-              icon  : "fas fa-pencil-alt"
-              url   : /architecture/
-
-Repositories links are displayed in website footer.
-
-
-### System components
-
-You can define the system components like Backend, Frontend etc. in *_config.yml*:
+... or:
 
-        system_components:
-          - name  : Frontend
-            techs :
-              - name: React.js
-              - name: Redux
-          - name  : Backend
-            techs :
-              - name: Ruby on Rails
-          - name  : Database
-            techs :
-              - name: PostgreSQL
-          - name  : Service provider
-            techs :
-              - name: AWS
-
-The "System components" are used in two components:
-
-* `project_overview.html` > `{% include project_overview.html %}`
-* `system_components_overview.html` > `{% include project_overview.html %}`
-
-
-### Versioning
-
-The documentation version is displayed in the footer.
-
-        doc_version       : 1.0.0
-
-
-## Components (includes)
+        ---
+        layout: page
+        ---
 
-### Project overview
+        {% include project_overview.html next_button="/docs/development/" %}
 
-The "Project overview" component renders:
 
-* `project_title`
-* `doc_version`
-* `description`
-* `getting_started`
-* `system_components`
-* `links`
+7. Run:
 
-Props:
+        bundle exec jekyll serve
 
-* `next_button` - URL for the "Get started!" button
+### What's next?
 
-Usage:
+Add more documents in *_docs* folder and see [advanced options](docs/01_advanced_options.md).
 
-        {% include project_overview.html next_button="/docs/development/" %}
 
-Example:
+## Advanced options
 
-![Project overview](docs/project_overview.png)
+See more: [advanced options](docs/01_advanced_options.md)
 
 
 ## Development
@@ -196,6 +109,11 @@ To set up your environment to develop this theme, run `bundle install`.
 To test theme, run: `bundle exec rake preview` or `bundle exec rake preview host=xxx.xx.xxx.xx`
 
 
+## Development todo's
+
+Add more templates, integrations with *the source code*, setup scripts.
+
+
 ## License
 
 The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_includes/feature_meta.html

@@ -1,30 +1,57 @@
-{% if page.status || page.prio || page.system_components || page.version %}
+{% if page.status or page.prio or page.system_components or page.version or page.vtags or page.vtag %}
   <div class='feature-meta'>
-    <div class='feature-meta__status'>
-      <label>Status:</label>
-      <div>
-        <span class='tag tag--{{ page.status }} feature-meta__status--{{ page.status }}'>{{ page.status }}</span>
+    {% if page.vtags or page.vtag %}
+      <div class='feature-meta__version'>
+        <label>Tags:</label>
+        <div>
+          {% if page.vtag %}
+            <span class='tag tag--{{ page.vtag | replace: " ", "-" }} feature-meta__status--{{ page.vtag | replace: " ", "-" }}'>{{ page.vtag }}</span>
+          {% endif %}
+          {% if page.vtags %}
+            {% for vtag in page.vtags %}
+              <span class='tag tag--{{ vtag | replace: " ", "-" }} feature-meta__status--{{ vtag | replace: " ", "-" }}'>{{ vtag }}</span>
+            {% endfor %}
+          {% endif %}
+        </div>
       </div>
-    </div>
-    <div class='feature-meta__prio'>
-      <label>Priority:</label>
-      <div>
-        <span class='tag tag--{{ page.prio }} feature-meta__prio--{{ page.prio }}'>{{ page.prio }}</span>
+    {% endif %}
+
+    {% if page.status %}
+      <div class='feature-meta__status'>
+        <label>Status:</label>
+        <div>
+          <span class='tag tag--{{ page.status }} feature-meta__status--{{ page.status }}'>{{ page.status }}</span>
+        </div>
       </div>
-    </div>
-    <div class='feature-meta__system_components'>
-      <label>System components:</label>
-      <div>
-        {% for component in page.system_components %}
-          <span class='tag'>{{ component }}</span>
-        {% endfor %}
+    {% endif %}
+
+    {% if page.prio %}
+      <div class='feature-meta__prio'>
+        <label>Priority:</label>
+        <div>
+          <span class='tag tag--{{ page.prio }} feature-meta__prio--{{ page.prio }}'>{{ page.prio }}</span>
+        </div>
       </div>
-    </div>
-    <div class='feature-meta__version'>
-      <label>Version:</label>
-      <div>
-        <span class='feature-meta__version'>{{ page.version }}</span>
+    {% endif %}
+
+    {% if page.system_components %}
+      <div class='feature-meta__system_components'>
+        <label>System components:</label>
+        <div>
+          {% for component in page.system_components %}
+            <span class='tag'>{{ component }}</span>
+          {% endfor %}
+        </div>
       </div>
-    </div>
+    {% endif %}
+
+    {% if page.version %}
+      <div class='feature-meta__version'>
+        <label>Version:</label>
+        <div>
+          <span class='feature-meta__version'>{{ page.version }}</span>
+        </div>
+      </div>
+    {% endif %}
   </div>
 {% endif %}

data/_includes/features/rails/rails_resource_controller.md

@@ -0,0 +1,167 @@
+{% assign model = include.model %}
+{% assign namespace = include.namespace %}
+
+{% assign tab = 0 %}
+{% capture namespace_modules %}{% for n in namespace %}
+{{ tab | indent }}module {{ n | camelcase }}{% assign tab = tab | plus:1 %}{% endfor %}{% endcapture %}
+
+```ruby
+# frozen_string_literal: true
+
+{{ namespace_modules }}{% capture _ %}{% increment tab %}{% endcapture %}
+{{ tab | indent  }}# {{ model.db_name | capitalize }} controller{% assign tab = tab + '  ' %}
+{{ tab | indent  }}class {{ model.db_name | camelcase }}Controller < BaseController
+      resource_description do
+        short '{{ model.db_name | capitalize }}'
+        deprecated false
+        description <<-DES
+          {{ model.db_name | capitalize }} resource.
+        DES
+      end
+
+      before_action :set_{{ model.name}}, except: [:index, :create]
+
+      api :GET, '/{{ model.db_name }}', 'See {{ model.db_name }}'
+      returns code: 200, desc: '{{ model.name | capitalize }} details' do
+        property :status, String, desc: '200'
+        property :message, String, desc: '{{ model.db_name | capitalize }} details'
+        property :data, Hash, desc: '{{ model.db_name | capitalize }} data' do
+          property :page, Integer
+          property :total, Integer
+          property :{{ model.db_name }}, Array do{% for field in model.fields %}
+            property :{{ field.name }}, {{ field.type | camelcase }}{% endfor %}
+            property :created_at, DateTime
+            property :updated_at, DateTime
+          end
+        end
+      end
+      example <<-DES
+      # Request:
+      [GET] /{{ model.db_name }}/{:id}
+      DES
+      def index
+        # TODO: Pagination and filters
+        @{{ model.db_name }} = {{ model.name | camelcase }}.all
+        send_response(200, 'List of {{ model.db_name | capitalize }}', nil, ActiveModel::Serializer::CollectionSerializer.new(@{{ model.db_name }}, serializer: {{ model.name | camelcase }}Serializer))
+      end
+
+      api :GET, '/{{ model.db_name }}/:id', 'See {{ model.name }} details'
+      param :id, String, desc: 'ID of the invitation', required: true
+      error code: 404, desc: 'NOT_FOUND'
+      returns code: 200, desc: '{{ model.name | capitalize }} details' do
+        property :status, String, desc: '200'
+        property :message, String, desc: '{{ model.name | capitalize }} details'
+        property :data, Hash, desc: '{{ model.name | capitalize }} data' do{% for field in model.fields %}
+          property :{{ field.name }}, {{ field.type | camelcase }}{% endfor %}
+          property :created_at, DateTime
+          property :updated_at, DateTime
+        end
+      end
+      example <<-DES
+      # Request:
+      [GET] /{{ model.db_name }}/{:id}
+      DES
+      def show
+        send_response(200, '{{ model.name | capitalize }} details', nil, {{ model.name | camelcase }}Serializer.new(@{{ model.name }}))
+      end
+
+      api :POST, '/{{ model.db_name }}', 'Create {{ model.name }}'
+      error code: 422, desc: 'RESOURCE_NOT_VALID'
+      returns code: 200, desc: '{{ model.name | capitalize }} details' do
+        property :status, String, desc: '200'
+        property :message, String, desc: '{{ model.name | capitalize }} details'
+        property :data, Hash, desc: '{{ model.name | capitalize }} data' do{% for field in model.fields %}
+          property :{{ field.name }}, {{ field.type | camelcase }}{% endfor %}
+          property :created_at, DateTime
+          property :updated_at, DateTime
+        end
+      end
+      example <<-DES
+      # Request:
+      [GET] /{{ model.db_name }}/{:id}
+      DES
+      def create
+        # Add strong params
+        @{{ model.name }} = {{ model.name | camelcase }}.new({{ model.name }}_params)
+        if @{{ model.name }}.save
+          send_response(200, '{{ model.name | capitalize }} details', nil, {{ model.name | camelcase }}Serializer.new(@{{ model.name }}))
+        else
+          send_response(422, '{{ model.name | capitalize }} error', 'RESOURCE_NOT_VALID', @{{ model.name }}.errors))
+        end
+      end
+
+      api :PUT, '/{{ model.db_name }}/:id', 'Update {{ model.name }}'
+      param :id, String, desc: 'ID of the invitation', required: true
+      error code: 403, desc: 'RESOURCE_NOT_VALID'
+      error code: 404, desc: 'NOT_FOUND'
+      returns code: 200, desc: '{{ model.name | capitalize }} details' do
+        property :status, String, desc: '200'
+        property :message, String, desc: '{{ model.name | capitalize }} details'
+        property :data, Hash, desc: '{{ model.name | capitalize }} data' do{% for field in model.fields %}
+          property :{{ field.name }}, {{ field.type | camelcase }}{% endfor %}
+          property :created_at, DateTime
+          property :updated_at, DateTime
+        end
+      end
+      example <<-DES
+      # Request:
+      [GET] /{{ model.db_name }}/{:id}
+      DES
+      def update
+        # Add strong params
+        @{{ model.name }} = {{ model.name | camelcase }}.assign_attributes({{ model.name }}_params)
+        if @{{ model.name }}
+          if @{{ model.name }}.save
+            send_response(200, '{{ model.name | capitalize }} updated', nil, {{ model.name | camelcase }}Serializer.new(@{{ model.name }}))
+          else
+            send_response(403, '{{ model.name | capitalize }} error', 'RESOURCE_NOT_VALID', @{{ model.name }}))
+          end
+        else
+          send_response(404, '{{ model.name | capitalize }} not found', 'NOT_FOUND', nil))
+        end
+      end
+
+      api :DELETE, '/{{ model.db_name }}/:id', 'Delete {{ model.name }}'
+      param :id, String, desc: 'ID of the invitation', required: true
+      error code: 403, desc: 'RESOURCE_NOT_VALID'
+      error code: 404, desc: 'NOT_FOUND'
+      returns code: 200, desc: '{{ model.name | capitalize }} details' do
+        property :status, String, desc: '200'
+        property :message, String, desc: '{{ model.name | capitalize }} details'
+        property :data, Hash, desc: '{{ model.name | capitalize }} data' do{% for field in model.fields %}
+          property :{{ field.name }}, {{ field.type | camelcase }}{% endfor %}
+          property :created_at, DateTime
+          property :updated_at, DateTime
+        end
+      end
+      example <<-DES
+      # Request:
+      [GET] /{{ model.db_name }}/{:id}
+      DES
+      def destroy
+        if @{{ model.name }}
+          if @{{ model.name }}.destroy
+            send_response(200, '{{ model.name | capitalize }} deleted', nil, {{ model.name | camelcase }}Serializer.new(@{{ model.name }}))
+          else
+            send_response(403, '{{ model.name | capitalize }} error', 'RESOURCE_NOT_VALID', @{{ model.name }}.errors))
+          end
+        else
+          send_response(404, '{{ model.name | capitalize }} not found', 'NOT_FOUND', nil))
+        end
+      end
+
+      private
+
+      def set_{{ model.name }}
+        @{{ model.name }} = {{ model.name | camelcase }}.find(params['id'])
+      end
+
+      def {{ model.name }}_params
+        params.require(:{{model.name}}).permit({% for f in model.fields %}:{{f.name}},{% endfor %})
+      end
+
+    end
+  end
+end
+
+```

data/_includes/features/rails/rails_resource_development.md

@@ -0,0 +1,50 @@
+
+{% assign model_name = include.model_name %}
+{% assign model = null %}
+
+{% if include.model %}
+  {% assign model = include.model %}
+{% else %}
+  {% for m in site.data.models %}
+    {% if m.name == model_name %}
+      {% assign model = m %}
+      {% break %}
+    {% endif %}
+  {% endfor %}
+{% endif %}
+
+{% assign namespace = null %}
+
+{% if include.namespace %}
+  {% assign namespace = include.namespace %}
+{% endif %}
+
+
+### Model
+
+{% include features/rails/rails_resource_model.md model=model %}
+
+
+### Controller
+
+{% include features/rails/rails_resource_controller.md model=model namespace=namespace %}
+
+
+### Routes
+
+{% include features/rails/rails_resource_routes.md model_name=model.db_name namespace=namespace %}
+
+
+### Queries
+
+{% include features/rails/rails_resource_query.md model=model %}
+
+
+### Serializer
+
+{% include features/rails/rails_resource_serializer.md model=model %}
+
+
+### Tests
+
+TODO

data/_includes/features/rails/rails_resource_model.md

@@ -0,0 +1,57 @@
+
+{% assign model=include.model %}
+
+{% include models/_model.html model=model %}
+
+### Generate model
+
+{% capture model_fields_cmd %}{% for field in model.fields %}{% if field.name != "id" %}{% if field.references %}{{ field.name | remove: '_id' }}:references {% else %}{{ field.name }}:{{ field.type }} {% endif %}{% endif %}{% endfor %}{% endcapture %}
+
+```bash
+$ rails g model {{ model.name | capitalize }} {{ model_fields_cmd }}
+```
+
+Migration:
+
+{% capture model_migration_file %}{% for field in model.fields %}
+      {% if field.references %}t.references :{{ field.name }}, foreign_key: true, type: :uuid{% if !field.references_optional %}, null: true{% endif %}{% else %}{% if field.name != "id" %}t.{{ field.type }} :{{ field.name }}{% endif %}{% if field.default %}, default: {{ field.default}}{% endif %}{% endif %}{% endfor %}{% endcapture %}
+
+```ruby
+# frozen_string_literal: true
+
+# Creates User Identities
+class Create{{ model.db_name | capitalize }} < ActiveRecord::Migration[6.0]
+  def change
+    create_table :{{ model.db_name }}, id: :uuid do |t|
+      {{ model_migration_file }}
+
+      t.timestamps
+    end
+  end
+end
+```
+
+### models/{{ model.name | capitalize }}.rb
+
+{% capture model_relations %}{% for r in model.relations %}
+  {{ r.type }}: {{ r.resource }}{% if r.optional %}, optional: true{% endif %}{% endfor %}{% endcapture %}
+
+{% capture model_validations %}{% for r in model.validations %}
+  validates :{{ r.field }}{% if r.presence %}, presence: true{% endif%}{% endfor %}{% endcapture %}
+
+{% capture model_enums %}{% for r in model.fields %}{% if r.enum %}
+  enum {{ r.name }}: { {% for e in r.enum_values %}
+    {{ e.val }}: {{e.key}},{% endfor %}
+  }{% endif %}{% endfor %}{% endcapture %}
+
+```ruby
+# frozen_string_literal: true
+
+# {{ model.name | capitalize }} model
+class {{ model.name | capitalize }} < ApplicationRecord
+  {{ model_validations }}
+  {{ model_relations }}
+  {{ model_enums }}
+
+end
+```

data/_includes/features/rails/rails_resource_query.md

@@ -0,0 +1,43 @@
+{% assign model = include.model %}
+
+`app/queries/{{ model.name }}_query.rb`
+
+```ruby
+# frozen_string_literal: true
+
+# {{ model.name | camelcase }} search query
+class {{ model.name | camelcase }}Query
+  # def initialize(params = {}, relation = {{ model.name | camelcase }}.left_outer_joins(
+  #     :subscriptions
+  #   ).preload(:acm_commodities, :acm_company, :acm_dot_numbers)
+  #   )
+  def initialize(params = {}, relation = {})
+    @relation = relation
+    @params = params
+  end
+
+  def all
+    @relation
+  end
+
+  def search_{{ model.db_name }}
+    # by_city
+    # by_name(@params[:search])
+    @relation
+  end
+
+  private
+
+  # def by_city
+  #   if @params[:city]
+  #     @relation = @relation.where('{{ model.db_name}}.city ILIKE ?', "%#{@params[:city]}%")
+  #   end
+  # end
+  #
+  # def by_name(name)
+  #   if name
+  #     @relation = @relation.where('{{ model.db_name}}.name ILIKE ?', "%#{@params[:name]}%")
+  #   end
+  # end
+end
+```

data/_includes/features/rails/rails_resource_routes.md

@@ -0,0 +1,13 @@
+{% assign model_name = include.model_name %}
+{% assign namespace = include.namespace %}
+
+{% assign tab = 0 %}
+{% capture namespace_modules %}{% for n in namespace %}
+{{ tab | indent }}namespace :{{ n }} do{% assign tab = tab | plus:1 %}{% endfor %}{% endcapture %}
+
+```ruby
+{{ namespace_modules }}
+    resources :{{ model_name}}
+  end
+end
+```

data/_includes/features/rails/rails_resource_serializer.md

@@ -0,0 +1,26 @@
+{% assign model = include.model %}
+
+
+`app/serializers/{{model.name}}_serializer.rb`
+
+```ruby
+# frozen_string_literal: true
+
+# {{ model.name | camelcase }} serializer
+class {{ model.name | camelcase }}Serializer < ActiveModel::Serializer
+  attributes {% for f in model.fields %}:{{ f.name}},{% endfor %}
+
+
+  # belongs_to :resource
+  # has_many :resource
+
+  # def lat
+  #   object.latlng.lat || nil
+  # end
+  #
+  # def lng
+  #   object.latlng.lon || nil
+  # end
+end
+
+```

data/_includes/features/react/api_service.md

@@ -0,0 +1,131 @@
+Network and API Services norms the way how the application sends HTTP requests.
+The API Service overrides the Network service by setting the host URL and adding necessary headers.
+
+### Network Service
+
+Create file `src/services/NetworkService.js`:
+
+```javascript
+import axios from 'axios'
+
+class NetworkService {
+  static async get(path, query, options) {
+    options = {
+      response: true,
+      queryStringParameters: {},
+      ...options
+    }
+    return await axios({
+      url: query ? `${path}?${query}` : path,
+      method: 'get',
+      ...options
+    })
+  }
+
+  static async post(path, query, data, options) {
+    options = {
+      response: true,
+      queryStringParameters: {},
+      ...options
+    }
+    return await axios({
+      url: query ? `${path}?${query}` : path,
+      data,
+      method: 'post',
+      ...options
+    })
+  }
+
+  static async put(path, query, data, options) {
+    options = {
+      response: true,
+      queryStringParameters: {},
+      ...options
+    }
+    return await axios({
+      url: query ? `${path}?${query}` : path,
+      data,
+      method: 'put'
+    })
+  }
+
+  static async delete(path, query) {
+    return await axios({
+      url: query ? `${path}?${query}` : path,
+      method: 'delete'
+    })
+  }
+}
+
+export default NetworkService
+
+```
+
+
+
+### API Service
+
+Add API URL to the config file `src/config/config.js`:
+
+```
+const prod = {
+  API_URL: 'https://domain.com/api/v1/',
+}
+
+const dev = {
+  API_URL: 'http://xxx.xxx.xx.xx:4000/api/v1/',
+}
+```
+
+Create file `src/services/APIService.js`:
+
+```javascript
+import config from '../config/config'
+import NetworkService from './NetworkService'
+// import AuthService from './AuthService' // Use to get Auth token to get an access to API
+
+class APIService {
+  static async get(path, query, options = {}) {
+    /* const header = await AuthService.getAuthToken()
+    const options = Object.assign(options, {
+      headers: header
+    }) */
+    const opts = Object.assign(options, {})
+    const response = await NetworkService.get(config.BACKEND_URL + path, query, opts)
+    return response
+  }
+
+  static async post(path, query, data, options = {}) {
+    /* const header = await AuthService.getAuthToken()
+    const options = Object.assign(options, {
+      headers: header
+    }) */
+    const opts = Object.assign(options, {})
+    const response = await NetworkService.post(config.BACKEND_URL + path, query, data, opts)
+    return response
+  }
+
+  static async put(path, query, data, options = {}) {
+    /* const header = await AuthService.getAuthToken()
+    const options = Object.assign(options, {
+      headers: header
+    }) */
+    const opts = Object.assign(options, {})
+    const response = await NetworkService.put(config.BACKEND_URL + path, query, data, opts)
+    return response
+  }
+
+  static async delete(path, options = {}) {
+    /* const header = await AuthService.getAuthToken()
+    const options = Object.assign(options, {
+      headers: header
+    }) */
+    const opts = Object.assign(opt, {})
+    const response = await NetworkService.delete(config.BACKEND_URL + path, opts)
+    return response
+  }
+}
+
+export default APIService
+
+```

data/_includes/features/react/app_init.md

@@ -0,0 +1,103 @@
+
+The application should perform initialization on start.
+
+The default strategy is to execute successive functions sequentially.
+Each function is a step that performs one and specific action.
+If the result is as expected, trigger next function. If the result is not as expected, stop the chain and return the response.
+
+Responses:
+
+```javascript
+// SUCCESS
+// Everything went OK. Handle the returned data, i.e. store the data in Redux with actions.
+{
+  status: 0,
+  data: { ... }
+}
+
+// ERROR
+// Something went wrong and application cannot be loaded
+{
+  status: 1,
+  error: 'API_UNREACHABLE', // The error code
+  data: { ... } // optional
+}
+
+// REDIRECT
+// The application should redirect the user
+{
+  status: 2,
+  url: '/sign-in', // User has to be redirected
+  message: 'MESSAGE_CODE' // i.e. message to display to the user
+}
+```
+
+### Plan
+
+#### 1. Add initialization script
+
+```javascript
+// src/Init.js
+/**
+ * Initialization script loading functions in a sequence.
+ *
+ * Statuses:
+ * 0 - sequence has been halted. It may mean that there was an error during initialization
+ * 1 - initialized with success.
+ * 2 - redirection
+ *
+ * @returns
+ */
+class Init {
+  static init() {
+    return this.firstFunction()
+  }
+
+  static async firstFunction() {
+    if (true) {
+      return this.secondFunction()
+    }
+    return {
+      status: 0,
+      message: 'APP_INITIALIZATION_FAILED',
+    }
+  }
+
+  static async secondFunction() {
+    return {
+      status: 0,
+      message: 'SUCCESS',
+      data: { a: 1, b: 2 }
+    }
+  }
+}
+
+export default Init
+```
+
+#### 2. Execute initialization script:
+
+```
+// src/App.jsx
+import Init from './Init.js'
+
+function App() {
+  const [initPerformed, setInitPerformed] = useState(false)
+  useEffect(() => {
+    if (!initPerformed) {
+      initializeApp()
+    }
+  }, [initPerformed])
+
+  async function initializeApp() {
+    await Init.init()
+    // OR:
+    // const response = await Init.init()
+    // Do something with response.. (i.e. Set Redux), check status (0,1,2), etc.
+    setInitPerformed(true)
+  }
+
+(...)
+}
+
+```

data/_includes/guidelines/rails/api_only_psql_no_admin_setup_instructions.md

@@ -189,6 +189,20 @@ Rails.application.config.generators do |g|
 end
 ```
 
+Generate migration:
+
+```bash
+$ rails g migration enable_uuid
+```
+
+```ruby
+class EnableUUID < ActiveRecord::Migration
+  def change
+    enable_extension 'pgcrypto'
+  end
+end
+```
+
 
 #### Apipie
 

data/_includes/instructions/how_to_share_documentation.md

@@ -0,0 +1,91 @@
+## How to share documentation
+
+
+### 1. Build project
+
+1. Build Jekyll project:
+
+```
+$ bundle exec jekyll build
+```
+
+2. Copy/download the content of the `_site` folder.
+
+3. You can also zip the content of `_site` folder before download:
+
+```
+$ zip -r docs.zip _site/
+```
+
+
+### 2. Share
+
+The built project (the `_site` folder) is a static website.
+
+
+#### 2.1 Open on the computer
+
+Download the project on local computer, navigate to the folder and open the `index.html`.
+
+
+#### 2.2 Host on VPS
+
+1. Copy files to the `/var/www/{project-name}` folder
+2. Create a new file in `/etc/nginx/sites-available/{project-name}.conf`
+3. Paste following configuration and adjust: port number, path to the `/var/www/{project-name}`
+
+        server {
+          listen 4004 default_server;
+          listen [::]:4004 default_server;
+
+          root /var/www/{project-name};
+
+          server_name _;
+
+          location / {
+            # First attempt to serve request as file, then as directory, then fall back to displaying a 404.
+            try_files $uri $uri/ =404;
+          }
+        }
+
+4. Add symlink
+
+        $ ln -s /etc/nginx/sites-available/{project-name}.conf /etc/nginx/sites-enabled/
+
+
+5. Test configuration
+
+        $ nginx -t
+
+6. Reload NGINX
+
+        $ systemctl reload nginx
+
+
+##### 2.2.1 Add basic auth
+
+1. Verify that apache2-utils (Debian, Ubuntu) or httpd-tools (RHEL/CentOS/Oracle Linux) is installed.
+
+2. Create credentials
+
+        $ sudo htpasswd -c /etc/nginx/.htpasswd user1
+
+3. Edit `/etc/nginx/sites-available/{project-name}.conf`
+
+        location / {
+          auth_basic           "Private Property";
+          auth_basic_user_file /etc/nginx/.htpasswd;
+        }
+
+4. Test configuration and reload nginx
+
+        $ nginx -t
+        $ systemctl reload nginx
+
+
+#### 2.3 Host on the AWS S3
+
+1. Create new bucket
+2. Upload files
+3. Set up ACL, permissions, CORS
+4. Set up S3 bucket as hosting

data/_includes/nav.html

@@ -38,10 +38,22 @@
       <li{{ current }}>
         <a href="{{ site.baseurl }}{{ doc.url }}" class='ad-nav-link'>
           <span class='title'>{{ doc.title }}</span>
-          {% if doc.status || doc.prio || doc.version %}
+          {% if doc.status or doc.prio or doc.version or doc.vtags or doc.vtag %}
             <div class='doc-meta-nav'>
-              <span class='tag tag--{{ doc.status }} feature-meta__status--{{ doc.status }}'>{{ doc.status }}</span>
-              <span class='tag tag--{{ doc.prio }} feature-meta__status--{{ doc.prio }}'>{{ doc.prio }}</span>
+              {% if doc.status %}
+                <span class='tag tag--{{ doc.status }} feature-meta__status--{{ doc.status }}'>{{ doc.status }}</span>
+              {% endif %}
+              {% if doc.prio %}
+                <span class='tag tag--{{ doc.prio }} feature-meta__status--{{ doc.prio }}'>{{ doc.prio }}</span>
+              {% endif %}
+              {% if doc.vtag %}
+                <span class='tag tag--{{ doc.vtag | replace: " ", "-" }} feature-meta__status--{{ doc.vtag | replace: " ", "-" }}'>{{ doc.vtag }}</span>
+              {% endif %}
+              {% if doc.vtags %}
+                {% for vtag in doc.vtags %}
+                  <span class='tag tag--{{ vtag | replace: " ", "-" }} feature-meta__status--{{ vtag | replace: " ", "-" }}'>{{ vtag }}</span>
+                {% endfor %}
+              {% endif %}
               <span class='version'>{{ doc.version }}</span>
             </div>
           {% endif %}

data/_includes/project_overview.html

@@ -15,7 +15,7 @@
       {% endif %}
     </div>
 
-    {% if site.system_components %}
+    {% if site.data.system_components %}
       <div class="ad-page-section">
         <h3><span class="symbol">&#128736;</span> System components</h3>
         {% include system_components_overview.html %}

data/_includes/requirements_list.html

@@ -0,0 +1,35 @@
+{% assign rlist = include.list %}
+{% assign rtitle = include.title %}
+{% if rtitle %}
+  <h2>{{ rtitle | upcase }}</h2>
+{% endif %}
+
+<div class="requirements-list">
+  {% for r in rlist %}
+    <div class="requirements-list__item">
+      {% if r.status %}
+        <span class="requirements-list__status tag">{{ r.status }}</span>
+      {% endif %}
+
+      <h3><span class="requirements-list__id">{{ r.id }}</span> {{ r.title }}</h3>
+
+      {% if r.description %}
+        <p>{{ r.description }}</p>
+      {% endif %}
+
+      {% if r.links %}
+        <ul class="links">
+          {% for l in r.links %}
+            {% assign link_name = l.source %}
+            {% if l.name %}
+              {% assign link_name = l.name %}
+            {% endif %}
+            <li>
+              <a href="{{ l.source }}">{{ link_name }}</a>
+            </li>
+          {% endfor %}
+        </ul>
+      {% endif %}
+    </div>
+  {% endfor %}
+</div>

data/_includes/system_components_overview.html

@@ -1,5 +1,5 @@
 <div class="ad-system_components">
-  {% for component in site.system_components %}
+  {% for component in site.data.system_components %}
     <div class="ad-system_component">
       <span class="name">{{ component.name }}</span>
       <ul>

data/_sass/jekyll-theme-alta-docs.scss

@@ -354,6 +354,7 @@ button.ad-collapsible, .ad-collapsible {
 
 .ad-doc__content {
   padding: 15px;
+  max-width: 800px;
 
   img {
     max-width: 100%;
@@ -510,6 +511,13 @@ button.ad-collapsible, .ad-collapsible {
   &.tag--high {
     background: #F20455;
   }
+
+  &.tag--epic {
+    background: #0392CC;
+  }
+  &.tag--user-story {
+    background: #ABC9B8;
+  }
 }
 
 .ad-nav-link {
@@ -576,6 +584,31 @@ button.ad-collapsible, .ad-collapsible {
   }
 }
 
+.requirements-list {
+  padding-top: 40px;
+  padding-bottom: 40px;
+  .requirements-list__item {
+    border-bottom: 1px solid $gray-200;
+    padding-top: 20px;
+    padding-bottom: 20px;
+    h4 {
+      margin-top: 0px;
+    }
+    .requirements-list__id {
+      font-size: 10px;
+      color: $primary-color;
+    }
+    ul.links {
+      margin-top: 20px;
+      list-style: none;
+      padding-left: 0;
+      margin-top: 3px;
+      margin-bottom: 3px;
+      font-size: 14px;
+    }
+  }
+}
+
 code.highlighter-rouge {
   background: $code-bg;
   padding: 1px 3px;
@@ -588,6 +621,7 @@ pre.highlight {
   background: $code-bg;
   border: 1px solid $gray-400;
   border-radius: 3px;
+  overflow-x: auto;
   .k {
     color: #e00bbc;
     font-weight: bold;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-alta-docs
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Tom Antas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2020-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -90,6 +90,14 @@ files:
 - LICENSE.txt
 - README.md
 - _includes/feature_meta.html
+- _includes/features/rails/rails_resource_controller.md
+- _includes/features/rails/rails_resource_development.md
+- _includes/features/rails/rails_resource_model.md
+- _includes/features/rails/rails_resource_query.md
+- _includes/features/rails/rails_resource_routes.md
+- _includes/features/rails/rails_resource_serializer.md
+- _includes/features/react/api_service.md
+- _includes/features/react/app_init.md
 - _includes/footer.html
 - _includes/guidelines/rails/api_only_project_tree.md
 - _includes/guidelines/rails/api_only_project_tree_with_files.md
@@ -100,11 +108,13 @@ files:
 - _includes/guidelines/react/react_project_tree.md
 - _includes/head.html
 - _includes/head_scripts.html
+- _includes/instructions/how_to_share_documentation.md
 - _includes/models/_model.html
 - _includes/models/_models_list.html
 - _includes/nav.html
 - _includes/navbar.html
 - _includes/project_overview.html
+- _includes/requirements_list.html
 - _includes/scripts.html
 - _includes/sidebar.html
 - _includes/system_components_overview.html
@@ -139,5 +149,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: The Jekyll theme for documenting software development projects..
+summary: The Jekyll theme for documenting software development projects.
 test_files: []