Uploaded image for project: 'Ignite'
  1. Ignite
  2. IGNITE-13524

Ignite Docs: fix Jekyll warnings reported during docs transformation to HTML

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Open
    • Major
    • Resolution: Unresolved
    • None
    • None
    • documentation
    • Docs Required, Release Notes Required

    Description

      Try to build the docs with the `run.sh` command located in the docs' root folder:
      https://github.com/apache/ignite/tree/master/docs

      Jekyll will report many warnings that need to be reviewed and handled. Some of the warnings are printed below:

      There is an empty tab (C#/.NET) on the JDBC Driver page: /Users/dmagda/ignite-website/_docs/_docs/SQL/JDBC/jdbc-driver.adoc
      There is an empty tab (C++) on the JDBC Driver page: /Users/dmagda/ignite-website/_docs/_docs/SQL/JDBC/jdbc-driver.adoc
      There is an empty tab (C++) on the SQL Performance Tuning page: /Users/dmagda/ignite-website/_docs/_docs/SQL/sql-tuning.adoc
      There is an empty tab (C++) on the Baseline Topology page: /Users/dmagda/ignite-website/_docs/_docs/clustering/baseline-topology.adoc
      There is an empty tab (C++) on the Baseline Topology page: /Users/dmagda/ignite-website/_docs/_docs/clustering/baseline-topology.adoc
      There is an empty tab (C++) on the Baseline Topology page: /Users/dmagda/ignite-website/_docs/_docs/clustering/baseline-topology.adoc
      There is an empty tab (C#/.NET) on the Connecting Client Nodes page: /Users/dmagda/ignite-website/_docs/_docs/clustering/connect-client-nodes.adoc
      There is an empty tab (C#/.NET) on the Connecting Client Nodes page: /Users/dmagda/ignite-website/_docs/_docs/clustering/connect-client-nodes.adoc
      There is an empty tab (C++) on the Connecting Client Nodes page: /Users/dmagda/ignite-website/_docs/_docs/clustering/connect-client-nodes.adoc
      There is an empty tab (C#/.NET) on the Connecting Client Nodes page: /Users/dmagda/ignite-website/_docs/_docs/clustering/connect-client-nodes.adoc
      There is an empty tab (C++) on the Deploying User Code page: /Users/dmagda/ignite-website/_docs/_docs/code-deployment/deploying-user-code.adoc
      There is an empty tab (C#/.NET) on the Deploying User Code page: /Users/dmagda/ignite-website/_docs/_docs/code-deployment/deploying-user-code.adoc
      There is an empty tab (C++) on the Deploying User Code page: /Users/dmagda/ignite-website/_docs/_docs/code-deployment/deploying-user-code.adoc
      asciidoctor: WARNING: <stdin>: line 56: id assigned to anchor already in use: readfrombackup
      There is an empty tab (C++) on the Partition Loss Policy page: /Users/dmagda/ignite-website/_docs/_docs/configuring-caches/partition-loss-policy.adoc
      There is an empty tab (C#/.NET) on the Partition Loss Policy page: /Users/dmagda/ignite-website/_docs/_docs/configuring-caches/partition-loss-policy.adoc
      There is an empty tab (C++) on the Partition Loss Policy page: /Users/dmagda/ignite-website/_docs/_docs/configuring-caches/partition-loss-policy.adoc
      There is an empty tab (C#/.NET) on the Partition Loss Policy page: /Users/dmagda/ignite-website/_docs/_docs/configuring-caches/partition-loss-policy.adoc
      There is an empty tab (C++) on the Partition Loss Policy page: /Users/dmagda/ignite-website/_docs/_docs/configuring-caches/partition-loss-policy.adoc
      There is an empty tab (C#/.NET) on the Partition Loss Policy page: /Users/dmagda/ignite-website/_docs/_docs/configuring-caches/partition-loss-policy.adoc
      There is an empty tab (C++) on the Partition Loss Policy page: /Users/dmagda/ignite-website/_docs/_docs/configuring-caches/partition-loss-policy.adoc
      There is an empty tab (C#/.NET) on the Partition Loss Policy page: /Users/dmagda/ignite-website/_docs/_docs/configuring-caches/partition-loss-policy.adoc
      There is an empty tab (C++) on the Partition Loss Policy page: /Users/dmagda/ignite-website/_docs/_docs/configuring-caches/partition-loss-policy.adoc
      asciidoctor: ERROR: configuration.adoc: line 3: level 0 sections can only be used when doctype is book
      Improper use of Lexer#lex - this method does not receive options. This will become an error in a future version.
      Improper use of Lexer#lex - this method does not receive options. This will become an error in a future version.
      Improper use of Lexer#lex - this method does not receive options. This will become an error in a future version.
      Improper use of Lexer#lex - this method does not receive options. This will become an error in a future version.
      There is an empty tab (C#/.NET) on the Cluster ID and Tag page: /Users/dmagda/ignite-website/_docs/_docs/monitoring-metrics/cluster-id.adoc
      There is an empty tab (C++) on the Cluster ID and Tag page: /Users/dmagda/ignite-website/_docs/_docs/monitoring-metrics/cluster-id.adoc
      There is an empty tab (C#/.NET) on the Cluster States page: /Users/dmagda/ignite-website/_docs/_docs/monitoring-metrics/cluster-states.adoc
      There is an empty tab (C++) on the Cluster States page: /Users/dmagda/ignite-website/_docs/_docs/monitoring-metrics/cluster-states.adoc
      There is an empty tab (C#/.NET) on the New Metrics System page: /Users/dmagda/ignite-website/_docs/_docs/monitoring-metrics/new-metrics-system.adoc
      There is an empty tab (C++) on the New Metrics System page: /Users/dmagda/ignite-website/_docs/_docs/monitoring-metrics/new-metrics-system.adoc
      There is an empty tab (C++) on the SQL Performance Tuning page: /Users/dmagda/ignite-website/_docs/_docs/perf-and-troubleshooting/sql-tuning.adoc
      There is an empty tab (C#/.NET) on the External Storage page: /Users/dmagda/ignite-website/_docs/_docs/persistence/external-storage.adoc
      There is an empty tab (C++) on the External Storage page: /Users/dmagda/ignite-website/_docs/_docs/persistence/external-storage.adoc
      There is an empty tab (C#/.NET) on the Ignite Persistence page: /Users/dmagda/ignite-website/_docs/_docs/persistence/native-persistence.adoc
      Improper use of Lexer#lex - this method does not receive options. This will become an error in a future version.
      There is an empty tab (C#/.NET) on the Transparent Data Encryption page: /Users/dmagda/ignite-websit
      

      Attachments

        Activity

          People

            Unassigned Unassigned
            dmagda Denis A. Magda
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: