Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken links #1483

Merged
merged 1 commit into from May 19, 2020
Merged

Fix broken links #1483

merged 1 commit into from May 19, 2020

Conversation

gideongrinberg
Copy link
Contributor

Description

This repairs broken links for custom connectors, databases, and skills on the contribution.md page. I couldn't find the pages they link to, so I linked them to the relevant portions of the docs.

I felt this was so easy to fix, I didn't open an issue.

Status

READY | UNDER DEVELOPMENT | ON HOLD

Type of change

  • Documentation (fix or adds documentation)

How Has This Been Tested?

I checked my version of the docs.

Checklist:

  • I have performed a self-review of my own code

@codecov
Copy link

codecov bot commented May 18, 2020

Codecov Report

Merging #1483 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1483   +/-   ##
=======================================
  Coverage   99.90%   99.90%           
=======================================
  Files          52       52           
  Lines        3283     3283           
=======================================
  Hits         3280     3280           
  Misses          3        3           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ec40872...869cc5e. Read the comment docs.

@gideongrinberg
Copy link
Contributor Author

gideongrinberg commented May 19, 2020

Hi, I am trying to further add to the docs, but, upon adding a new markdown document, I receive an error from tox -e docs that says [...]/opsdroid/docs/quickstart.md:document isn't included in any toctree. ERROR: InvocationError for command [...]/opsdroid/.tox/docs/bin/sphinx-build -W -b html docs/ docs/_build/ (exited with code 2). How do I add to the toctree? I know this probably isn't the place to ask, but I didn't want to open an issue just because I am unfamiliar with Sphinx.

@jacobtomlinson
Copy link
Member

I know this probably isn't the place to ask, but I didn't want to open an issue just because I am unfamiliar with Sphinx.

I would be ok with you raising an issue like this. It's quick to answer and close again. You could also ask in the Matrix chat.

To answer your question you need to add it to one of the toctree sections in the index.

Copy link
Member

@jacobtomlinson jacobtomlinson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good thanks.

@jacobtomlinson jacobtomlinson merged commit 5682527 into opsdroid:master May 19, 2020
@gideongrinberg
Copy link
Contributor Author

@jacobtomlinson thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants