Skip to content

Commit

Permalink
[#2011] Fix bugs in UG (#2013)
Browse files Browse the repository at this point in the history
Some of the links in the FAQ and troubleshooting
sections of the UG are not working. Some embedded 
content is also not being rendered correctly.

Let's update the links and fix the embedded content.
  • Loading branch information
nseah21 committed Jul 14, 2023
1 parent 95f97da commit ae805c8
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/ug/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ To enable *RepoSense* to work on private repositories, ensure that you have enab

### Q: How do formats work?
**A:** **Formats** are the [file extensions](https://techterms.com/definition/fileextension), which is the **suffix** at the end of a filename that indicates what type of file it is.<br>
The formats/file extensions to be analyzed by *RepoSense* can be specified through the [standalone config file](#provide-data-using-a-json-config-file), [repo-config file](#repo-configcsv), and [command line](#customize-using-command-line-parameters).
The formats/file extensions to be analyzed by *RepoSense* can be specified through the [standalone config file](./configFiles.md#config-json-standalone-config-file), [repo-config file](./configFiles.md#repo-config-csv), and [command line](./cli.md#formats-f).

<!-- ------------------------------------------------------------------------------------------------------ -->

### Q: How does ignore glob list work?
**A:** [Glob](https://en.wikipedia.org/wiki/Glob_(programming)) is the pattern to specify a set of filenames with [wildcard characters](https://www.computerhope.com/jargon/w/wildcard.htm). **Ignore glob list** is the list of patterns to specify all the files in the repository which should be ignored from analysis.<br>
The ignore glob list can be specified through the [standalone config file](#provide-data-using-a-json-config-file), [repo-config file](#repo-config-csv), and [author-config file](#author-config-csv).
The ignore glob list can be specified through the [standalone config file](./configFiles.md#config-json-standalone-config-file), [repo-config file](./configFiles.md#repo-config-csv), and [author-config file](./configFiles.md#author-config-csv).
File renamed without changes.
8 changes: 4 additions & 4 deletions docs/ug/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@

### Contributions missing in the ramp chart (but appear in the contribution bar and code panel)

This is probably a case of giving an incorrect author name alias (or GitHub ID) in your [author-config file](#author-config-csv).<br>
Please refer to [A Note About Git Author Name](#a-note-about-git-author-name) above on how to find out the correct author name you are using and how to change it.<br>
This is probably a case of giving an incorrect author name alias (or GitHub ID) in your [author-config file](./configFiles.md#author-config-csv).<br>
Please refer to [A Note About Git Author Name](./configFiles.md#a-note-about-git-author-name) above on how to find out the correct author name you are using and how to change it.<br>
Also, ensure that you have added all author name aliases you may be using (if you are using multiple computers or have previously changed your author name).<br>
Alternatively, you may choose to configure *RepoSense* to track using your GitHub email instead of in your [standalone config file](#provide-data-using-a-json-config-file) or [author-config file](#author-config-csv), which is more accurate compared to author name aliases. The associated GitHub email you are using can be found in your [GitHub settings](https://github.com/settings/emails).
Alternatively, you may choose to configure *RepoSense* to track using your GitHub email instead of in your [standalone config file](./configFiles.md#config-json-standalone-config-file) or [author-config file](./configFiles.md#author-config-csv), which is more accurate compared to author name aliases. The associated GitHub email you are using can be found in your [GitHub settings](https://github.com/settings/emails).


<!-- ------------------------------------------------------------------------------------------------------ -->

### Contribution bar and code panel is empty (despite a non-empty ramp chart)

The contribution bar and code panel records the lines you have authored to the **latest** commit of the repository and branch you are analyzing. As such, it is possible that while you have lots of committed contributions, your final authorship contribution is low. This happens if you have only deleted lines or someone else has overwritten your code and taken authorship for it (currently, RepoSense does not have the functionality to track overwritten lines).<br>
It is also possible that another user has overridden the authorship of your lines using the [@@author tags](#provide-data-using-author-tags).
It is also possible that another user has overridden the authorship of your lines using the [@@author tags](./usingAuthorTags.md#appendix-using-author-tags).

<!-- ------------------------------------------------------------------------------------------------------ -->

Expand Down
4 changes: 2 additions & 2 deletions docs/ug/withTravis.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ The instructions below assume you are using GitHub pages to host your report.

{{ step(2)}} **Generate a _personal access token_ or _deploy key_ on GitHub** as explained in the panel below.

{{ embed("Granting write access on GitHub", "grantingWriteAccess.mbdf") }}
{{ embed("Granting write access on GitHub", "grantingWriteAccess.md") }}

{{ step(3) }} **Login to [Travis-CI](https://travis-ci.org/).** You may have to sign up first.

{{ step(4) }} **Syncy your Travis account with GitHub:**
{{ step(4) }} **Sync your Travis account with GitHub:**

1. Go to [your account](https://travis-ci.org/account/repositories).
1. Click on `Sync account` to fetch all your repositories into Travis-CI.
Expand Down

0 comments on commit ae805c8

Please sign in to comment.