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

Rename support.md to README.md #1175

Merged
merged 3 commits into from
Jun 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .config/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ nav:
- common-practices-tools/security/incidents.md
- common-practices-tools/skills-base.md
- Software and support:
- common-practices-tools/software-and-support/support.md
- common-practices-tools/software-and-support/README.md
- company-policies/new-hire-orientation/bookmarks.md
- common-practices-tools/software-and-support/email.md
- common-practices-tools/software-and-support/github.md
Expand Down
3 changes: 3 additions & 0 deletions .config/redirects.yml
Original file line number Diff line number Diff line change
Expand Up @@ -484,3 +484,6 @@
- from_url: /common-practices-tools/agile/agile-overview/
to_url: /common-practices-tools/agile/
type: page
- from_url: /common-practices-tools/software-and-support/support/
to_url: /common-practices-tools/software-and-support/
type: page
2 changes: 1 addition & 1 deletion common-practices-tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ Underpinning our chosen technology stack is a [required security awareness proce

## Get support

Request help with internal systems and services (Slack, Zoom, GSuite, Gitlab, CI server, etc.) from our [internal support team](software-and-support/support.md).
Request help with internal systems and services (Slack, Zoom, GSuite, Gitlab, CI server, etc.) from our [internal support team](software-and-support/README.md).
6 changes: 3 additions & 3 deletions common-practices-tools/skills-base.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ When you first log in you will need to go through a short onboarding:
Notes:

- If you have specific additional skills you can add these (after the initial self-assessment) by navigating to [your skills tab](https://app.skills-base.com/people/view#skills) and clicking "Add a skill".
- If you normally work in more than one of the teams listed then open a [support ticket](software-and-support/support.md#to-request-support) to request those be added to your user.
- If you normally work in more than one of the teams listed then open a [support ticket](software-and-support/README.md#to-request-support) to request those be added to your user.
- If you work in an internal department, select the "CivicActions" team.
- Skills Base does support supervisor assessments, but we are not currently using that functionality.

Expand Down Expand Up @@ -126,7 +126,7 @@ The easiest way to do this is using the "People finder" in the sidebar. You can

## If you have other needs

There is a custom report builder that can be used to answer many other queries we might have. Open a [support ticket](software-and-support/support.md#to-request-support) and describe what you are looking for!
There is a custom report builder that can be used to answer many other queries we might have. Open a [support ticket](software-and-support/README.md#to-request-support) and describe what you are looking for!

## Managing the skills catalog

Expand All @@ -140,7 +140,7 @@ Note that the categories of skills [do not correspond 1-1 with teams](https://su

In some cases, there may be some cross-over or duplication of skills between two teams. In this case, both teams will need to work together to identify how to refactor the catalog to ensure it is logical and avoids duplicate skills or overlap. The IT department can help facilitate these changes as needed.

- Open a [support ticket](software-and-support/support.md#to-request-support) to request access to manage skills.
- Open a [support ticket](software-and-support/README.md#to-request-support) to request access to manage skills.
- Request training from IT if you haven't done this before.
- Spend time becoming familiar with the catalog as a whole and search for similar skills before adding new ones.
- Add descriptions to each skill wherever possible.
2 changes: 1 addition & 1 deletion common-practices-tools/software-and-support/slack.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ title: Slack

## Tips

- Did you know you can [request support](support.md) using Slack?
- Did you know you can [request support](README.md) using Slack?
- Consider using the word "ping" to check on the availability of someone
- Create a Zoom from Slack: type **/zoom** (will need to authorize)
- Create a Google Meet from Slack: type **/hangout** (will need to authorize the slack app in Meet/Hangout too)
Expand Down
2 changes: 1 addition & 1 deletion common-practices-tools/software-and-support/zoom.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
- Meetings are limited to 40 minutes.
- No recording is possible.

Paid accounts are available for those who need them regularly (once a week or so, or if you host a regular call that needs Zoom). If you need to host a longer meeting, or you need to record a meeting, you can either ask a project manager or someone you know has a paid account to host it for you, or you can request a paid account by opening an [IT ticket](support.md).
Paid accounts are available for those who need them regularly (once a week or so, or if you host a regular call that needs Zoom). If you need to host a longer meeting, or you need to record a meeting, you can either ask a project manager or someone you know has a paid account to host it for you, or you can request a paid account by opening an [IT ticket](README.md).

Check warning on line 20 in common-practices-tools/software-and-support/zoom.md

View workflow job for this annotation

GitHub Actions / remark-lint-suggestions

[remark-lint-suggestions] common-practices-tools/software-and-support/zoom.md#L20

`host` may be insensitive, use `presenter`, `entertainer`, `emcee` instead host-hostess retext-equality
Raw output
    20:93-20:97  warning  `host` may be insensitive, use `presenter`, `entertainer`, `emcee` instead      host-hostess     retext-equality

Check warning on line 20 in common-practices-tools/software-and-support/zoom.md

View workflow job for this annotation

GitHub Actions / remark-lint-suggestions

[remark-lint-suggestions] common-practices-tools/software-and-support/zoom.md#L20

`host` may be insensitive, use `presenter`, `entertainer`, `emcee` instead host-hostess retext-equality
Raw output
  20:146-20:150  warning  `host` may be insensitive, use `presenter`, `entertainer`, `emcee` instead      host-hostess     retext-equality

Check warning on line 20 in common-practices-tools/software-and-support/zoom.md

View workflow job for this annotation

GitHub Actions / remark-lint-suggestions

[remark-lint-suggestions] common-practices-tools/software-and-support/zoom.md#L20

`host` may be insensitive, use `presenter`, `entertainer`, `emcee` instead host-hostess retext-equality
Raw output
  20:281-20:285  warning  `host` may be insensitive, use `presenter`, `entertainer`, `emcee` instead      host-hostess     retext-equality

## Video call best practices

Expand Down
2 changes: 1 addition & 1 deletion practice-areas/engineering/text-editors-ides.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ We use text editors to develop code, tests, and documentation, and to manage con
We use a variety of text editors and IDEs, and you are welcome to use whichever one you prefer. We do not require that you use a specific IDE or text editor, however if you need support then we strongly suggest that you use one of the editors that is commonly used by the team.

- [VSCodium](https://vscodium.com/) or [VS Code](https://code.visualstudio.com/): This is probably the most commonly used IDE on the team. It is a free, open source, cross platform editor that is available for Linux, Mac and Windows. It has a large number of extensions available, and is very configurable. Note that the official VS Code binaries do include a few closed source components (e.g. icons, marketplace integration) - VSCodium builds exclude these. For questions ask in [#engineering-vscode](https://civicactions.slack.com/messages/engineering-vscode/).
- [PHPStorm](https://www.jetbrains.com/phpstorm/) or other JetBrains IDEs: This is a commercial, closed source IDE that is available for Linux, Mac and Windows. It has a large number of features and is very configurable. It can be particular helpful if you do a lot of PHP debugging with XDebug. If you are not already a user, you could start with a free trial - if you like it and need a license [open an IT ticket](../../common-practices-tools/software-and-support/support.md) and request one. For questions ask in [#engineering-phpstorm](https://civicactions.slack.com/messages/engineering-phpstorm/).
- [PHPStorm](https://www.jetbrains.com/phpstorm/) or other JetBrains IDEs: This is a commercial, closed source IDE that is available for Linux, Mac and Windows. It has a large number of features and is very configurable. It can be particular helpful if you do a lot of PHP debugging with XDebug. If you are not already a user, you could start with a free trial - if you like it and need a license [open an IT ticket](../../common-practices-tools/software-and-support/README.md) and request one. For questions ask in [#engineering-phpstorm](https://civicactions.slack.com/messages/engineering-phpstorm/).
- [Vim](http://www.vim.org/)/[Neovim](https://neovim.io/) and [Emacs](https://www.gnu.org/software/emacs/): These are free, open source, cross platform and keyboard driven text editors - or IDEs if configured more maximally, such as with [AstroNvim](https://astronvim.com/) or [Spacemacs](https://www.spacemacs.org/). They are available for Linux, Mac (typically via [Homebrew](http://brew.sh/)) and Windows (typically via [WSL](https://learn.microsoft.com/en-us/windows/wsl/install)). They are very powerful tools for text manipulation, but can have a steep learning curve - however, the skills learned can be used on both the IDEs above which have good Vim and Emacs keybindings and plugins, as well as on servers where they are often installed by default.

If you still have questions, ask in Slack: [#engineering](https://civicactions.slack.com/messages/engineering/)
2 changes: 1 addition & 1 deletion practice-areas/help-desk/helpdesk.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Overview

# CivicActions Project Support

Note: this is the Project Support practice area. We have separate documentation that describes [how to request internal support](../../common-practices-tools/software-and-support/support.md).
Note: this is the Project Support practice area. We have separate documentation that describes [how to request internal support](../../common-practices-tools/software-and-support/README.md).

## Mission

Expand Down