[docs] fix: broken links #764
Conversation
With the move to monorepo, there are a lot of broken GitHub repo links which are invalid.
✅ Deploy Preview for nemtech ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
|
Hey @fboucquez, I also update the broken links for the symbol-bootstrap. Can you take a look? |
There was a problem hiding this comment.
This is a massive commit and I haven't read it thoroughly, I hope links are indeed fixed correctly :)
My only comment is that the autogenerated html tables maybe could go in a separate commit, to reduce the bulk of the commit. You know these tables are generated by the project https://github.com/symbol/catapult-docs-cli and not by hand, right?
You better update that project too... :D
Thanks Xavi. It make sense but no didnt know how these html files were created. The update was mainly search and replace. :) |
| @@ -230,7 +230,7 @@ Just like in the harvesting case, this creates the required :ref:`votingkeylinkt | |||
| symbol-bootstrap updateVotingKeys | |||
There was a problem hiding this comment.
Should a guide to rewnew certificates with bootstrap be added? Probably in a new PR.
https://github.com/fboucquez/symbol-bootstrap/blob/dev/docs/renewCertificates.md
There was a problem hiding this comment.
Yes, renew certificates is a new PR. Can you write one?
| @@ -270,7 +268,7 @@ You need to own the domain ``awesomenode.mycompany.net`` and it needs to resolve | |||
| Next steps | |||
| ********** | |||
|
|
|||
| - Read the `complete list <https://github.com/symbol/symbol-bootstrap/blob/main/README.md#user-content-commands>`_ of ``symbol-bootstrap`` commands. | |||
| - Read the `complete list <https://github.com/fboucquez/symbol-bootstrap/blob/main/README.md>`_ of ``symbol-bootstrap`` commands. | |||
There was a problem hiding this comment.
https://docs.symbol.dev/handbook/doc-common-tasks.html#update-the-serialization-tables The README is outdated now that the directory structure has changed, and the default paths for the |
|
I think the links look good. Just 2 comments. I'll advice when files are moved around in bootstrap.
|
|
@segfaultxavi I looked at the |
Address feedback. Disable link check for GitHub since they are now returning 403.
source/conf.py
Outdated
| @@ -355,6 +355,9 @@ def setup(app): | |||
| r'https://arxiv.org/.*', # Sometimes returns 403 on Travis (rate limit?) | |||
| r'https://www.researchgate.net/.*', # Started returning 403 on Travis | |||
| r'https://symbolblog.com/.*', # Returning 403 | |||
| r'https://docs.github.com/.*', # GitHub is now returning 403 | |||
| r'https://help.github.com/.*', # GitHub is now returning 403 | |||
| r'https://github.com/fboucquez/symbol-bootstrap#command-topics', # Returning Anchor 'command-topics' not found | |||
There was a problem hiding this comment.
I'd really prefer that we do not overpopulate this list... this is weakening the link check :/
I think the right anchor in this case is:
https://github.com/fboucquez/symbol-bootstrap#user-content-command-topics
Also, all these 403 might be related to throttling? The link checker has a mechanism to avoid making too many consecutive requests to the same server, but maybe changing the CI has altered that?
There was a problem hiding this comment.
Thanks Xavi, I think I found the issue with 403 error. If I add with user_agent it seems to fix the problem
There was a problem hiding this comment.
The updated link for bootstrap also fix the issue
Add ``user_agent`` which seems to fix 403 errors.
With the move to monorepo, there are a lot of broken GitHub repo links which are invalid.
There is no more catbuffer generators project since this is now part of each sdk. Open issue #763 to keep track of this.
Moved the make alldocs and linkcheck to the build script