After we completed the creation of the project on the basis of the previous lessons, a README.md file has been generated. In this lesson, we will explain how to update the file by submitting the file locally and editing it online.
However, if it is a text-based file update, it will involve the writing of content grammar, which can be written based on Markdown grammar. Many websites widely use Markdown to write help documents or post messages on forums.
The syntax is very simple, you can refer to the Markdown official website tutorial.
If it is modified locally, you can directly clone the project (for specific tutorials, please refer to Lesson 5) to the local, so that the saved files are the latest, and errors can also be avoided.
Open the file to modify it on Notepad. Generally, the README.md file is a simple introduction and guidance for this project, which is convenient for everyone to understand.
(1)Update content based on existing files
When we modify the content of the file locally, for example, after we enter any content in the README.md file, press Ctrl+S to save.
In the blank space of the local project folder, right-click [Git GUI Here].
The Git GUI window pops up, as shown in the figure.
Click [Commit] on the menu bar to drop down and click [Stage To Commit]
(If there are multiple files, remember to select all files first, and then click Commit>Stage To Commit)
At this point, the README.md file has been moved to the Stage Changes area, and the corresponding content must be entered in the Commit Message box on the right, based on the action of this update, and it must be in English, for example, I simply enter “update” here.
Then click the Commit button, the file has been submitted, the next step is to click the Push button, and the Push window will pop up.
Here, you can directly click the Push button in the lower right corner. The pop-up window displays success, which means that we have successfully pushed the submitted file to the community project. Click to close.
At this point, go back to the personal center code page, and when the page is refreshed, we can see that the content of the README.md file has been updated synchronously.
(2)Create multiple files for submission
When we create some new files locally and need to upload or update them synchronously to the Qizhi community project, for example, I copied a few more copies of the README.md file locally.
Based on the GUI window that has been opened, you can click Rescan to help us quickly scan for new files.
(If the window has been closed, you can right-click [Git GUI Here] to reopen)
At this point, after selecting all the newly added files, click [Stage To Commit] under the [Commit] menu bar, then enter the corresponding content in the Commit Message, click the Commit button, and then click the Push button~
The AI Collaboration Platform added an online quick edit entry for the README file in the recent version. We can also update and upload files directly online. However, if the update is submitted online and the update needs to be performed locally, it is best to clone it.
(1) Edit the README file online
Click the pencil icon on the right side of the file to edit the file online.
After entering the editing page, the content is also edited through Markdown syntax.
During the editing process or after editing, you can click the button [Preview] next to [Edit File] to view the effect of the file online, and then click [Submit Changes].
(2) Upload files online
On the code page, click the button [Upload File], uploading a file will add a new folder by default, you can enter the name of the folder at [Add Directory], and then drag the file directly into the dotted box or click Upload, enter in the text Add a description of the file in the box, and finally click [Submit Changes].
(3) Create a new file online
On the code page, click the button [New File].
On the new file page, enter the file name in [Name File], and enter the relevant content of the file in the text box.
After filling in the content, scroll down and click [Submit Changes].
After creating a new file, you can click the icon on the right to edit and change the file or delete the file.
Dear OpenI User
Thank you for your continuous support to the Openl Qizhi Community AI Collaboration Platform. In order to protect your usage rights and ensure network security, we updated the Openl Qizhi Community AI Collaboration Platform Usage Agreement in January 2024. The updated agreement specifies that users are prohibited from using intranet penetration tools. After you click "Agree and continue", you can continue to use our services. Thank you for your cooperation and understanding.
For more agreement content, please refer to the《Openl Qizhi Community AI Collaboration Platform Usage Agreement》