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.

Sign up for GitHub

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

Jump to bottom

Fix some minor cosmetic issues in docs #2218

Closed
wants to merge 5 commits into from
Closed

Fix some minor cosmetic issues in docs #2218

wants to merge 5 commits into from

Conversation

damithc
Copy link
Collaborator

@damithc damithc commented May 16, 2024 •
edited by ckcherry23
Loading

Fixes for some minor cosmetic issues I noticed while reading the UG.

You can do a rebase merge for this, as each commit is a separate fix.

Fix some minor cosmetic issues in docs

The documentation site for RepoSense uses the legacy <span> syntax for
defining variables. The example dashboards are also outdated. Moreover, the
word 'Git' has been capitalised wrongly in the docs.

Let's update variables.md to use the proper <variable> syntax instead
of the legacy <span> syntax for defining variables. Also, let's remove
the variables.json file as it is not used. Let's update links of example
dashboards to point to a later version which uses a more recent version of
RepoSense. Lastly, let's fix the 'Git' typos across the docs.

damithc added 4 commits May 16, 2024 23:55
variables.md: Use <varialbe> syntax
e6dfa3d 
Let's update varialbes.md to use the proper <varialbe> syntax
 instead of the legacy <span> syntax for defining variables.
docs: Remove variables.json
43e97c8 
Let's remove the variables.json file as it is not used.
Update outdated links to example reports
2c39b14 
Let's update links of example dashboards to point to a later
version which uses a more recent version of RepoSense.
Fix typo: git -> Git
8d75802
ckcherry23
ckcherry23 approved these changes May 17, 2024
View reviewed changes
Copy link
Member

@ckcherry23 ckcherry23 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@ckcherry23
Copy link
Member

I'll have to squash merge as "Rebase and merge" is disabled for RepoSense.

@ckcherry23 ckcherry23 changed the title Fixes for some minor cosmetic issues in docs Fix some minor cosmetic issues in docs May 17, 2024
@damithc
Copy link
Collaborator Author

damithc commented May 17, 2024

I'll have to squash merge as "Rebase and merge" is disabled for RepoSense.

@ckcherry23 I enabled it just now.

@ckcherry23 ckcherry23 mentioned this pull request May 17, 2024
Merged
@ckcherry23
Copy link
Member

ckcherry23 commented May 17, 2024 •
edited
Loading

Completed in #2221 to rebase with master instead of merge commits

@ckcherry23 ckcherry23 closed this May 17, 2024
@github-actions GitHub Actions
Copy link
Contributor

The following links are for previewing this pull request:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ckcherry23 ckcherry23 ckcherry23 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@damithc @ckcherry23