Merge pull request #311 from rolling-scopes-school/sync-missing-docs

dzmitry-varabei · web-flow · commit 0aa294623995 · 2025-12-05T13:18:59.000+01:00
Sync missing documentation files: Add schedule, notifications, privat…
diff --git a/docs/en/docsMenu_en.json b/docs/en/docsMenu_en.json
@@ -235,6 +235,10 @@
         "title": "Overview",
         "link": "rs-app"
       },
+      {
+        "title": "Schedule",
+        "link": "rs-app-schedule"
+      },
       {
         "title": "Submitting Assignments in RS APP",
         "link": "rs-app-tasks"
@@ -243,12 +247,50 @@
         "title": "Cross check",
         "link": "cross-check-flow"
       },
+      {
+        "title": "Notifications",
+        "link": "notifications"
+      },
       {
         "title": "Typical Problems",
         "link": "rs-app-issues"
       }
     ]
   },
+  {
+    "title": "Private Repository",
+    "items": [
+      {
+        "title": "Private Repository",
+        "link": "private-repository"
+      },
+      {
+        "title": "Git Convention",
+        "link": "git-convention"
+      }
+    ]
+  },
+  {
+    "title": "How to help the school?",
+    "items": [
+      {
+        "title": "Become an Activist",
+        "link": "rs-school-activist"
+      },
+      {
+        "title": "How to Fix a Typo in Documentation?",
+        "link": "fix-typo"
+      },
+      {
+        "title": "Who are RSS AI?",
+        "link": "rs-school-ai"
+      },
+      {
+        "title": "Support Community",
+        "link": "fundraiser"
+      }
+    ]
+  },
   {
     "title": "How to contribute",
     "link": "how-to-contribute"
diff --git a/docs/en/fix-typo.md b/docs/en/fix-typo.md
@@ -0,0 +1,88 @@
+# How to Make Changes to RS School Documentation
+
+If you notice an inaccuracy or typo in the [school documentation](https://docs.rs.school/#/), or in an assignment description, it's advisable to fix it.
+
+The documentation repository is [here](https://github.com/rolling-scopes-school/docs)
+
+If necessary, you can discuss changes in an issue, [for example](https://github.com/rolling-scopes-school/docs/issues/33).
+But if the content of the fixes is obvious to you, it's better to create a **Pull Request**.
+
+## How to Add Changes to Someone Else's Repository
+
+By sending a Pull Request, you're proposing to the repository author and all interested parties to review the changes you've made and merge them into the project. If the changes are reasonable and appropriate, your Pull Request will be accepted.
+
+I'll show you how to do this using the example of the repository https://github.com/rolling-scopes-school/docs
+
+### 1. Make Your Own Copy of the Repository
+
+To do this, click the "Fork" button on the repository page.
+
+![image](../images/fix-typo1.png)
+
+As a result, a copy of the repository appears in your account.
+
+![image](../images/fix-typo2.png)
+
+The address of your repository copy contains your GitHub account name.
+
+- Original repository `https://github.com/rolling-scopes-school/docs`
+- Created copy `https://github.com/irinainina/docs`
+
+### 2. Clone Your Own Copy of the Repository to Your Computer
+
+```sh
+git clone https://github.com/irinainina/docs
+```
+
+## 3. Link the Local Copy to the Original Repository
+
+To do this, go to the cloned repository folder and run two commands:
+
+```sh
+git remote add upstream https://github.com/rolling-scopes-school/docs
+git fetch upstream
+```
+
+![image](../images/fix-typo3.png)
+
+### 4. Create Your Own Development Branch
+
+The branch name usually indicates the content of the edits. Let's assume our branch will be called `fix-typo`. The command to create a new branch `fix-typo` and make it active:
+
+```sh
+git checkout -b fix-typo
+```
+
+At this point, we can already edit the code and add the necessary changes to it.
+
+### 5. Add Changes to Your Own Copy of the Repository
+
+As soon as you've done the work (or part of it), send it to your own copy of the repository on GitHub.
+To do this, run the commands:
+
+```sh
+git add .
+git commit -m "feat: add fix-typo"
+git push origin fix-typo
+```
+
+### 6. Return Changes: Pull request
+
+So, everything is done. You've written the code, it's in your `fix-typo` branch both on your computer and on GitHub. All that's left is to send it to the original repository.
+
+Go to your repository copy page on GitHub, select the `fix-typo` branch and click the Pull Request button.
+![image](../images/fix-typo4.png)
+
+Add a title and description of your changes and click the "Create pull request" button.
+![image](../images/fix-typo5.png)
+
+### What's Next?
+
+Follow your Pull Request. See what people comment, what the maintainer says, whether they accept or reject your proposed edits.
+
+Using the same principle, you can fix errors in the [course assignments repository](https://github.com/rolling-scopes-school/tasks) or even propose your own tasks.
+
+Only the repository name will change, but the principle of working with the repository remains unchanged. Because it's the foundation of collaborative work on GitHub and creating open-source projects.
+
+[Source](https://habr.com/ru/post/125999/)
+
diff --git a/docs/en/notifications.md b/docs/en/notifications.md
@@ -0,0 +1,23 @@
+## Rolling Scopes School Notifications
+
+## Notification Types
+
+- You, as a mentor, are approved for the course (contains links to confirm participation as a mentor, **does not require subscription**).
+- Your task was reviewed by a mentor/cross-check (contains the grade, maximum grade for this task, grade 'weight').
+- Upcoming deadline for tasks/tests/cross-check/interviews/presentations (contains course name(s), task name(s), and a link to RS App).
+- Message (feedback) from reviewers/reviewees during cross-check.
+
+## Channels
+
+- **Telegram**: Notifications come from [@rsschool_bot](https://t.me/rsschool_bot)
+- **E-mail**: Notifications come to E-Mail
+
+## How to subscribe/unsubscribe from notifications
+
+**In the `Contacts` card (in [profile](https://app.rs.school/profile)), the `E-Mail` and `Telegram` fields (without `@`) must be filled in. Fields are case-sensitive.**
+
+1. In the profile, go to [Notifications](https://app.rs.school/profile/notifications).
+2. On the `Notifications` page, check the boxes next to the channels you want to subscribe to.
+
+**To change the subscription status for `Telegram` notifications in the profile, you need to subscribe/unsubscribe in a conversation with [@rsschool_bot](https://t.me/rsschool_bot)**
+
diff --git a/docs/en/private-repository.md b/docs/en/private-repository.md
@@ -0,0 +1,73 @@
+# Private Repository
+
+## How to create your private repository in RS School?
+
+At the beginning of the course, you need to:
+
+- open `Dashboard` in [RS App](https://app.rs.school)
+- click "Create repository" (or "Fix repository" if repository settings need to be reset to initial state)
+- GitHub automatically sends you an invite to access the repository. The invite comes to the email you specified when registering on GitHub (not the email you specified in RS App)
+
+## How to work with a private repository?
+
+- Clone it to your computer:
+  `git clone https://github.com/rolling-scopes-school/<your-school-repository>.git`
+- Go to the cloned repository folder:
+  `cd <your-school-repository>`
+- Set your data in the config (enter the email linked [to your GitHub account](https://github.com/settings/emails)):
+  `git config user.name "Name Surname"`
+  `git config user.email "your@email"`
+- Create a branch from `main` with the assignment name:
+  `git checkout -b <task-name>`
+- Create a folder with the assignment name:
+  `mkdir <task-name>`
+  All files related to the assignment should be in it.
+- Complete the assignment, committing solutions in the process (see [commit requirements](https://docs.rs.school/#/git-convention)).
+- Push the branch to the remote branch on GitHub:
+  `git push origin <task-name>`
+- Create a Pull Request from branch `<task-name>` to branch `main`. You don't need to merge the Pull Request.
+
+## How to deploy an assignment from the school's private repository?
+
+1. In the `gh-pages` branch, you need to place a folder with the assignment name, and the project files in it. The `index.html` file should be at the top level. This can be done in two ways:
+   - for projects that don't use `webpack`, it's enough to make a Pull Request from the development branch to the `gh-pages` branch and merge it.
+   - for projects that use `webpack`, you need to create a project build by running the `npm run build` command, create a folder with the assignment name in the `gh-pages` branch, and place the built project files in the created folder. Note that the `.gitignore` file lists the names of folders created during application build. Therefore, in the `gh-pages` branch, the `.gitignore` file can be deleted.
+2. The link to the deployed application version looks like: `https://rolling-scopes-school.github.io/repository-name/folder-name`, where
+   - `repository-name` - your repository name in rs school
+   - `folder-name` - the folder name with project files
+3. All other projects are deployed this way, a separate folder is created for each of them
+   - this is how the `gh-pages` branch [looks](https://docs.rs.school/images/deploy-to-gh-pages.png) with project folders
+   - example link: `https://rolling-scopes-school.github.io/irinainina-JS2020Q3/repair-design-project/`
+
+#### Video&nbsp;[Deploy to GitHub Pages](https://www.youtube.com/watch?v=0lvKcqP3aP0)
+
+## FAQ
+
+### I deleted the gh-pages branch, what should I do?
+
+1. Create the `gh-pages` branch from `main` again and push it to your school private repository
+2. In `Dashboard` RS App, click the `Fix repository` button
+3. Make any commit to the `gh-pages` branch and push the changes. (Each push to `gh-pages` triggers the deployment mechanism for this branch)
+4. Wait 5 minutes
+
+### I can't open/merge a Pull Request from the development branch to the gh-pages branch, what should I do?
+
+1. Delete the `gh-pages` branch on GitHub
+2. In `Dashboard` RS App, click the `Fix repository` button
+3. Merge the Pull Request into the `gh-pages` branch
+
+### My site is not deploying and the Deployments section is not appearing, what should I do?
+
+- Go to the settings of the private repository and check/set the required branch for deployment: `gh-pages/root`
+- If there's no settings section, in `Dashboard` RS App, click the `Fix repository` button, settings should appear.
+
+![private-repo-settings-info](../images/private-repo-pages-settings.png)
+
+## Adding a list of completed assignments and contacts to the private repository
+
+The created private repository already has a `readme.md` file with the repository name.
+You can add your contacts (or a link to CV with contacts) to this file and maintain a list of completed assignments in it. This will help reviewers find your work in case of an error during submission.
+
+After creating the `gh-pages` branch from `main`, this file will be copied there and will be available at
+`https://rolling-scopes-school.github.io/<repository-name>/`
+
diff --git a/docs/en/rs-app-schedule.md b/docs/en/rs-app-schedule.md
@@ -0,0 +1,39 @@
+## Schedule in RS APP
+
+For successful completion of the selected course in **RS App**, there is a **schedule** that can be accessed from the main menu
+
+1. Select the desired course
+2. Go to the link or Schedule tab
+
+![schedule](../images/schedule-1.png)
+
+#### General view of the schedule
+
+![schedule view](../images/schedule-2.png)
+
+#### Schedule control panel
+
+![schedule control panel](../images/schedule-3.png)
+
+1. Filter by assignment status
+2. Time zone selection
+3. Hide/show individual table columns
+4. Event tag color settings
+
+#### Event/assignment details
+
+Clicking a link from the schedule opens a page with the event/assignment description.
+
+#### Using the schedule
+
+For convenient use of the schedule in RS App, the following features are provided:
+
+![schedule control panel](../images/schedule-4.png)
+
+1. Filter by assignment status
+2. Search by event/assignment name
+3. Filter by assignment type
+4. Sort by assignment release date
+5. Sort by assignment end date
+6. Search by organizer
+
