CodeQL Learning Catalog

CodeQLラーニングカタログは、CodeQLを学習していただくためのハンズオンを含んだコンテンツとなります。

How to Use The Catalog

次の２つの環境でご利用いただけます。

Codespaces
ローカルPC

Codespaces

Codespace環境設定と生成の手順を以下に説明します

ブランチ<ワークショップタイトル>-<レベル>を作成（例：qlc-100)
Code->Codespaces->+ New with option

3. Create codespaceのウィンドウが表示されるので、各項目について選択 Branchは、１で作成したブランチ名を指定(`qlc-100`)、Dev container configurationには、`CodeQL Learning Catalog(Authors)`、Machine Typeは`8-core`推奨

4. 設定が完了したら、`Create codespace`ボタン押下

ローカルPC

git cloneコマンドで、本リポジトリをローカルにクローン

ディレクトリ構成

ディレクトリ構成について説明します。ワークショップは、すべてdocsディレクトリは以下になります。その下に２つのワークショップがあります。１つは言語に依存しないワークショップ、もう１つは言語依存のワークショップとなります。言語依存のワークショップは現在C++,pythonの２つになります。

言語非依存のワークショップ

言語 非依存 ワークショップは言語依存とは異なり、１種類のみのワークショップです。

言語依存のワークショップ

言語依存のワークショップは、言語ごとのワークショップになっております。例えば、cppは１つのワークショップ、pythonは別ワークショップとなります。

index.mdファイルのメタデータ

それぞれのワークショップのディレクトリには、index.mdファイルがあります。その中に以下のメタデータがあります。 course_numberの見方は、<ワークショップタイトル>-<レベル>となっています。

ワークショップタイトル	説明
QLC	CodeQL Core
LDF	Language Dependent Features
TIP	Tooling,Infrastructure,and Practice
EXP	Explorations

レベル	説明
10x	基本レベル
20x	中級レベル
30x	アドバンスドレベル

---
layout: workshop-index
title: Elements of Syntactical Program Analysis I for Python
course_number: LDF-101-PY
abstract: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Blandit volutpat maecenas volutpat blandit. Ut morbi tincidunt augue interdum. Cursus eget nunc scelerisque viverra. Et tortor consequat id porta nibh venenatis cras sed felis. Ante metus dictum at tempor commodo ullamcorper. Aliquam purus sit amet luctus venenatis lectus magna. 
language: python
feedback: https://www.feedback.com 
banner: banner-code-graph-shield.png
video: url-to-your-video
deck: url-to-your-deck 
octicon: package
toc: false
---
## Previewing Your Work


To preview your work, at a command prompt type:

script/server


From the root of this repository. 

## Inserting Code Blocks

To prevent examples that do not run from being used in workshops, this system
provides a way to ensure your examples are runnable. 

Any time you have a `ql` example, you must provide a unit test and a source file
for the `ql`. To insert that code into your workshop you may use custom
directives. 

**To insert an entire file**

<pre>
```ql file=./src/myfile.ql

To insert a portion of a file

```ql file=./src/solutions/PuzzleOneAttemptTwoB.ql#L1-L17
```

Making Your Content Findable

To increase relevancy of results, the workshop catalog does not perform full text indexing. Search results are based on two factors: 1) title and 2) topics. You may influence the search relevancy by either altering your title or adding a topics metadata tag to the frontmatter of any page. For example:

---
layout: workshop-index
title: Elements of Syntactical Program Analysis I for C/C++
topics: dataflow, taint
toc: false
---

yuuki1967 / codeql-learning-catalog Goto Github PK