Skip to content

Commit

Permalink
[docs]: fix broken build
Browse files Browse the repository at this point in the history
problem: Github fails to find Anchors in markdown.
solution: ignore these failures since the are resolve when click
              Update Jenkinsfile to the latest.
  • Loading branch information
Wayonb authored Nov 15, 2023
1 parent 4760f43 commit 9167bcf
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 9 deletions.
8 changes: 5 additions & 3 deletions Jenkinsfile
Original file line number Diff line number Diff line change
@@ -1,7 1,9 @@
defaultCiPipeline {
platform = ['ubuntu']
ciBuildDockerfile = 'linter.Dockerfile'

operatingSystem = ['ubuntu']
instanceSize = 'medium'

environment = 'linter'

publisher = 'gh-pages'

gitHubId = 'Symbol-Github-app'
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 1,6 @@
# Symbol Documentation

[![Build Status](https://travis-ci.com/symbol/symbol-docs.svg?branch=main)](https://travis-ci.com/symbol/symbol-docs)
[![Build Status](https://jenkins.symboldev.com/job/Symbol/job/Docs/job/symbol-docs/job/main/badge/icon)](https://jenkins.symboldev.com/job/Symbol/job/Docs/job/symbol-docs/job/main/)

Browse the documentation to start integrating blockchain technology into your project.

Expand Down
3 changes: 0 additions & 3 deletions catapult-docs-cli/README.md
Original file line number Diff line number Diff line change
@@ -1,8 1,5 @@
# catapult-docs-cli

[![PyPI](https://img.shields.io/pypi/v/catapultdocscli)](https://pypi.org/project/catapultdocscli/)
[![Build Status](https://travis-ci.com/symbol/catapult-docs-cli.svg?branch=master)](https://travis-ci.com/symbol/catapult-docs-cli)

Exports documentation available in ``catapult-server`` and ``catapult-rest`` code into reStructuredText tables.

The generated outputs are used in the [Symbol Developer Documentation](http://symbol.github.io).
Expand Down
1 change: 1 addition & 0 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 356,7 @@ def setup(app):
r'https://www.researchgate.net/*', # 403 Client Error
r'https://support.ledger.com/*', # 403 Client Error
r'https://par.nsf.gov/*', # unsafe legacy renegotiation disabled
r'https://github.com/*', # Anchor not found
]
linkcheck_anchors_ignore = [r'L\d ']

Expand Down
2 changes: 1 addition & 1 deletion source/guides/network/using-symbol-bootstrap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 262,7 @@ You need to own the domain ``awesomenode.mycompany.net`` and it needs to resolve

.. note::

This option has been heavily inspired by `this great blog <https://nemlog.nem.social/blog/58808>`__. Symbol Bootstrap simply bundles this solution, streamlining the process.
This option has been heavily inspired by the community and Symbol Bootstrap simply bundles this solution, streamlining the process.

**********
Next steps
Expand Down
4 changes: 3 additions & 1 deletion source/handbook/doc-repos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 71,9 @@ This generates all HTML files in the ``build/html`` folder, including all assets
Deployment
----------

The GitHub repository is linked to `Travis <https://travis-ci.com/github/symbol/symbol-docs>`__, so on every push to the ``main`` branch a full build is triggered (See ``.travis.yml`` and the ``travis`` folder for details). This involves several steps besides the generation of the output documentation:
The GitHub repository is linked to `Jenkins <https://jenkins.symboldev.com/job/Symbol/job/Docs/job/symbol-docs>`__, so on every push to the
``main`` branch a full build is triggered (See ``Jenkinsfile``). This involves several steps besides
the generation of the output documentation:

- **Source snippets validation**: The guides include lots of source code examples which are actually snippets from complete programs. These programs must **compile** and pass **lint checks** at all times and Travis makes sure of this. Right now only the TypeScript programs are checked.
- **Link checking**: All pages are examined to find broken links using ``make linkcheck``.
Expand Down

0 comments on commit 9167bcf

Please sign in to comment.