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

Develop fix documentation broken reference #3906

Conversation

ultimatecoder
Copy link
Contributor

@ultimatecoder ultimatecoder commented Oct 25, 2018

Status

Ready for review

Description of Changes

  1. Fixing broken reference of "authenticated Tor hiddenservice" at overview section of the documentation.

2. Edit vim generates tags files using ctags. This functionality helps to traverse to the definition of method, function or class. It is a meta file. Ignoring this file will solve the problem of mistakenly committing this file to the source.

Steps to find broken reference at the documentation

  1. Go to Overview of the documentation.
  2. Find Sub section named Technical Summary
  3. Go to the description of second point named Application Server: Ubuntu server running ...
  4. Find reference of authenticated Tor hidden service at the beginning of second last line.
  5. Click on that link, you will be redirected to a broken page.

Checklist

If you made changes to documentation:

  • [ x ] Doc linting (make docs-lint) passed locally

This commit is a fix to a broken reference of authenticated Tor hidden
service at documentation.
.gitignore Outdated
@@ -104,6 +104,7 @@ ENV/
*~
*.swp
*.swo
tags
Copy link

@sayanchowdhury sayanchowdhury Oct 25, 2018

Choose a reason for hiding this comment

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

This IMO should go into global gitignore, the reason being the file name is customizable. The default filename for ctags is 'tags'.

Copy link
Contributor

Choose a reason for hiding this comment

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

I concur on that. That's something for your global gitignore, rather than something in this git repo.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree. I have removed that. Thanks @sayanchowdhury and @edenemmanuel for your review :)

@ultimatecoder
Copy link
Contributor Author

@edenemmanuel I have updated the code according to your comments. Thanks!

@sayanchowdhury
Copy link

That last commit looks weird, Squash into one.

@ultimatecoder
Copy link
Contributor Author

@sayanchowdhury OOops, I forgot to push after squashing. Thanks for notifying though!

@ultimatecoder ultimatecoder force-pushed the develop-fix-documentation-broken-reference branch from cc0b644 to f1add93 Compare October 26, 2018 15:36
Copy link
Contributor

@redshiftzero redshiftzero left a comment

Choose a reason for hiding this comment

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

👍 thanks!

@redshiftzero redshiftzero merged commit 267e011 into freedomofpress:develop Oct 26, 2018
@ultimatecoder ultimatecoder deleted the develop-fix-documentation-broken-reference branch October 27, 2018 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants