Skip to content

Commit

Permalink
ci: check links (#54)
Browse files Browse the repository at this point in the history
* ci: check links

* ci(check-link): set root directory

* ci(check-link): fail on errors

* ci(check-link): disable verbose

* fix(contributing): fix link to build from source 81ce85a
  • Loading branch information
coder3101 committed Aug 5, 2020
1 parent fcf30c3 commit 1386f3b
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/contribution-guidelines/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -863,7 +863,7 @@ <h2 id="what-kinds-of-contributions-are-we-looking-for">What kinds of contributi
<h2 id="your-first-contribution">Your First Contribution</h2>
<p><strong>Working on your first Pull Request?</strong> You can learn how from this <em>free</em> series <a href="https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github" target="_blank">How to Contribute to an Open Source Project on GitHub</a>. Basically, you have to fork this repository, write codes on your fork, open a pull request when you are finished, wait for reviews and apply suggestions from the maintainers.</p>
<p><strong>First time to developing?</strong> There&rsquo;s a big difference between developing and competitive programming, but it&rsquo;s not hard. The first thing you should know is Object-Oriented Programming. Basically, you need to know how classes work in C++, and you should know it&rsquo;s a rule to put the class definitions in the <code>.hpp</code> files, and put the implementation of the functions in the <code>.cpp</code> files. The source code of the CP Editor is a good example. Google for what you want to implement is usually helpful. Copy and modify the source codes if you want to implement something similar to an existing feature. If you are looking for an IDE for developing, <a href="https://code.visualstudio.com/" target="_blank">VS Code</a> is probably a good choice.</p>
<p><strong>First time to Qt?</strong> Don&rsquo;t be afraid, Qt is not hard to get started. You have to install Qt&gt;=5.14 and CMake&gt;=3.5 first. Linux users may install them using the package manager on your system. Windows users may download Qt <a href="https://www.qt.io/offline-installers" target="_blank">here</a> and it&rsquo;s recommended to use <a href="https://visualstudio.microsoft.com/" target="_blank">Visual Studio</a> and install the CMake plugin. Read the <a href="doc/INSTALL.md#Build-from-source">build from source</a> section to learn how to build. Read the <a href="https://doc.qt.io/" target="_blank">Qt docs</a> on how to use Qt built-in widgets, how to design the UI and how to use the <a href="https://doc.qt.io/qt-5/signalsandslots.html" target="_blank">signals and slots</a>. Usually, you don&rsquo;t need anything from the std namespace, for example, use <code>QString</code> instead of <code>std::string</code>.</p>
<p><strong>First time to Qt?</strong> Don&rsquo;t be afraid, Qt is not hard to get started. You have to install Qt&gt;=5.14 and CMake&gt;=3.5 first. Linux users may install them using the package manager on your system. Windows users may download Qt <a href="https://www.qt.io/offline-installers" target="_blank">here</a> and it&rsquo;s recommended to use <a href="https://visualstudio.microsoft.com/" target="_blank">Visual Studio</a> and install the CMake plugin. Read the <a href="../installation/build-from-source">build from source</a> section to learn how to build. Read the <a href="https://doc.qt.io/" target="_blank">Qt docs</a> on how to use Qt built-in widgets, how to design the UI and how to use the <a href="https://doc.qt.io/qt-5/signalsandslots.html" target="_blank">signals and slots</a>. Usually, you don&rsquo;t need anything from the std namespace, for example, use <code>QString</code> instead of <code>std::string</code>.</p>
<p><strong>Don&rsquo;t know where to start?</strong> You can start by looking through the <a href="https://github.com/cpeditor/cpeditor/issues" target="_blank">issues</a> and find one you are interested in. The <a href="https://github.com/cpeditor/cpeditor/issues?q=is%3Aissue&#43;is%3Aopen&#43;label%3A%22good&#43;first&#43;issue%22" target="_blank">good first issues</a> may be suitable for you. Ask in the <a href="https://t.me/cpeditor" target="_blank">Telegram group</a> or under the issues if you have any questions.</p>
<h2 id="before-writing-codes">Before Writing Codes</h2>
<p>Please open an issue (describe the feature/bug like normal issues, and say that you are going to work on it, probably with a draft on how you would like to implement it) before writing codes for a pull request, for these reasons:</p>
Expand Down Expand Up @@ -1041,7 +1041,7 @@ <h2 class="feedback--title">Feedback</h2>
<br />


<div class="text-muted mt-5 pt-3 border-top">Last modified June 13, 2020: <a href="https://github.com/cpeditor/cpeditor.github.io/commit/2a4596219f8af1ae050c62184cfdcbce1ffce33f">Update Docs (#27) (2a45962)</a>
<div class="text-muted mt-5 pt-3 border-top">Last modified August 5, 2020: <a href="https://github.com/cpeditor/cpeditor.github.io/commit/81ce85a1e863c49dc29934d7ebb8f3b46f382a85">ci: check links (#54) (81ce85a)</a>
</div>
</div>

Expand Down
2 changes: 1 addition & 1 deletion en/sitemap.xml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<?xml version="1.0" encoding="utf-8" standalone="yes"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml"><url><loc>/docs/components/main-window/menu-bar/file/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/installation/install-from-binaries/</loc><lastmod>2020-07-21T20:31:17+08:00</lastmod></url><url><loc>/docs/installation/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/main-window/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/main-window/menu-bar/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/installation/build-from-source/</loc><lastmod>2020-06-13T07:38:31+00:00</lastmod></url><url><loc>/docs/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/main-window/menu-bar/edit/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/blog/news/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/preferences/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/blog/releases/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/main-window/menu-bar/actions/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/main-window/code-editor/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/setup/</loc><lastmod>2020-06-28T15:05:25+08:00</lastmod></url><url><loc>/docs/components/main-window/tab-bar/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/installation/use-artifacts/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/installation/build-from-aur/</loc><lastmod>2020-06-13T07:38:31+00:00</lastmod></url><url><loc>/docs/features/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/main-window/message-logger/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/main-window/menu-bar/view/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/main-window/menu-bar/options/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/main-window/test-cases/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/main-window/menu-bar/help/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/source-code/</loc><lastmod>2020-05-19T16:42:12+08:00</lastmod></url><url><loc>/docs/faq/</loc><lastmod>2020-07-21T16:56:03+08:00</lastmod></url><url><loc>/docs/contribution-guidelines/</loc><lastmod>2020-06-13T07:38:31+00:00</lastmod></url><url><loc>/blog/2020/04/28/cp-editor-v6.4/</loc><lastmod>2020-04-29T08:17:29+08:00</lastmod></url><url><loc>/blog/2020/04/28/use-language-server-in-cp-editor/</loc><lastmod>2020-04-29T08:17:29+08:00</lastmod></url><url><loc>/about/</loc><lastmod>2020-04-29T08:10:13+08:00</lastmod></url><url><loc>/blog/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/community/</loc><lastmod>2020-04-21T09:48:10+08:00</lastmod></url><url><loc>/</loc><lastmod>2020-07-26T01:49:35+02:00</lastmod><xhtml:link rel="alternate" hreflang="zh" href="/zh/"/><xhtml:link rel="alternate" hreflang="en" href="/"/></url><url><loc>/download/</loc><lastmod>2020-07-26T04:13:48+08:00</lastmod></url></urlset>
<?xml version="1.0" encoding="utf-8" standalone="yes"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml"><url><loc>/docs/components/main-window/menu-bar/file/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/installation/install-from-binaries/</loc><lastmod>2020-07-21T20:31:17+08:00</lastmod></url><url><loc>/docs/installation/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/main-window/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/main-window/menu-bar/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/installation/build-from-source/</loc><lastmod>2020-06-13T07:38:31+00:00</lastmod></url><url><loc>/docs/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/main-window/menu-bar/edit/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/blog/news/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/preferences/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/blog/releases/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/main-window/menu-bar/actions/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/main-window/code-editor/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/setup/</loc><lastmod>2020-06-28T15:05:25+08:00</lastmod></url><url><loc>/docs/components/main-window/tab-bar/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/installation/use-artifacts/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/installation/build-from-aur/</loc><lastmod>2020-06-13T07:38:31+00:00</lastmod></url><url><loc>/docs/features/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/main-window/message-logger/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/main-window/menu-bar/view/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/main-window/menu-bar/options/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/main-window/test-cases/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/components/main-window/menu-bar/help/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/docs/source-code/</loc><lastmod>2020-05-19T16:42:12+08:00</lastmod></url><url><loc>/docs/faq/</loc><lastmod>2020-07-21T16:56:03+08:00</lastmod></url><url><loc>/docs/contribution-guidelines/</loc><lastmod>2020-08-05T22:08:36+08:00</lastmod></url><url><loc>/blog/2020/04/28/cp-editor-v6.4/</loc><lastmod>2020-04-29T08:17:29+08:00</lastmod></url><url><loc>/blog/2020/04/28/use-language-server-in-cp-editor/</loc><lastmod>2020-04-29T08:17:29+08:00</lastmod></url><url><loc>/about/</loc><lastmod>2020-04-29T08:10:13+08:00</lastmod></url><url><loc>/blog/</loc><lastmod>2020-04-28T15:25:21+08:00</lastmod></url><url><loc>/community/</loc><lastmod>2020-04-21T09:48:10+08:00</lastmod></url><url><loc>/</loc><lastmod>2020-07-26T01:49:35+02:00</lastmod><xhtml:link rel="alternate" hreflang="zh" href="/zh/"/><xhtml:link rel="alternate" hreflang="en" href="/"/></url><url><loc>/download/</loc><lastmod>2020-07-26T04:13:48+08:00</lastmod></url></urlset>
2 changes: 1 addition & 1 deletion sitemap.xml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<?xml version="1.0" encoding="utf-8" standalone="yes"?><sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><sitemap><loc>/zh/sitemap.xml</loc></sitemap><sitemap><loc>/en/sitemap.xml</loc><lastmod>2020-07-26T01:49:35+02:00</lastmod></sitemap></sitemapindex>
<?xml version="1.0" encoding="utf-8" standalone="yes"?><sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><sitemap><loc>/zh/sitemap.xml</loc></sitemap><sitemap><loc>/en/sitemap.xml</loc><lastmod>2020-08-05T22:08:36+08:00</lastmod></sitemap></sitemapindex>

0 comments on commit 1386f3b

Please sign in to comment.