Skip to content

Latest commit

ย 

History

History
44 lines (32 loc) ยท 3.08 KB

File metadata and controls

44 lines (32 loc) ยท 3.08 KB

Azure Engineering Notes

Azure ๊ธฐ๋ฐ˜ ์‹œ์Šคํ…œ์˜ ์„ค๊ณ„ยท๊ตฌํ˜„ยท์šด์˜ ๊ธฐ๋ก์„ ๊ณต์œ ํ•ฉ๋‹ˆ๋‹ค. ์‹ค์ œ ๋ฌธ์ œ ํ•ด๊ฒฐ ์ด๋ ฅ๊ณผ ์ง€์†์ ์œผ๋กœ ๊ฐฑ์‹ ํ•˜๋Š” ๊ธฐ์ˆ  ๊ฐ€์ด๋“œ๋ฅผ ๊ณต๊ฐœํ•˜๋Š” ๋ฌธ์„œ ์ €์žฅ์†Œ์ž…๋‹ˆ๋‹ค.

๋ฌธ์„œ ์‚ฌ์ดํŠธ

Azure Engineering Notes์—์„œ ๋ฌธ์„œ ๋ณด๊ธฐ

์‚ฌ์ดํŠธ์—์„œ๋Š” ์„œ๋น„์Šค๋ณ„ ๋ณด๊ธฐ ๋˜๋Š” ๊ธ€ ์ฐพ๊ธฐ๋กœ ํƒ์ƒ‰ํ•ฉ๋‹ˆ๋‹ค. ๊ธ€ ์ฐพ๊ธฐ๋Š” ๋ชจ๋“  ์ฃผ์ œ๋ฅผ ์นด๋“œ๋กœ ๋ฌถ๊ณ  ์„œ๋น„์Šค, ๋ชฉ์ ยท์ฃผ์ œ ํƒœ๊ทธ, ๊ธฐ์ˆ , ์ œ๋ชฉยท์„ค๋ช…์œผ๋กœ ์ขํž™๋‹ˆ๋‹ค. ํƒœ๊ทธ ํ•˜๋‚˜๋ฅผ ์„ ํƒํ•˜๋ฉด ๊ทธ ํƒœ๊ทธ๊ฐ€ ๋ถ™์€ ๋ฌธ์„œ๋งŒ, ์—ฌ๋Ÿฌ ํƒœ๊ทธ๋ฅผ ์„ ํƒํ•˜๋ฉด ๋ชจ๋“  ํƒœ๊ทธ๊ฐ€ ๋ถ™์€ ๋ฌธ์„œ๋งŒ ์ฃผ์ œ ์•ˆ์— ํ‘œ์‹œํ•˜๋ฉฐ ๊ฐ ๋ฌธ์„œ๋กœ ๋ฐ”๋กœ ์—ฐ๊ฒฐํ•ฉ๋‹ˆ๋‹ค. ์„œ๋น„์Šคยท๊ธฐ์ˆ ยท๊ฒ€์ƒ‰์–ด๋„ ๊ฐ™์€ ๋ฌธ์„œ์— AND๋กœ ์ ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ฒฐ๊ณผ์—๋Š” ์ฃผ์ œ ์ˆ˜์™€ ๋ฌธ์„œ ์ˆ˜๋ฅผ ํ•จ๊ป˜ ํ‘œ์‹œํ•ฉ๋‹ˆ๋‹ค. ๋ณ„๋„์˜ ์ „์ฒด ํ…์ŠคํŠธ ๊ฒ€์ƒ‰์—์„œ๋Š” ํ•œ๊ตญ์–ดยท์˜์–ด ์ œ๋ชฉ๊ณผ ๋ณธ๋ฌธ, ์ œํ’ˆ๋ช…, ์˜ค๋ฅ˜ ๋ฉ”์‹œ์ง€๋ฅผ ์ฐพ์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๊ธ€ ์ฐพ๊ธฐ์˜ ์ œ๋ชฉยท์„ค๋ช… ๊ฒ€์ƒ‰์–ด๋Š” ๋ฐ˜๋ณต ๊ฐ€๋Šฅํ•œ text๋กœ ๊ณต์œ ํ•ฉ๋‹ˆ๋‹ค (์˜ˆ: /explore/?tag=design&text=Agent&text=Memory). q๋Š” ์‚ฌ์ดํŠธ ์ „์ฒด ๊ฒ€์ƒ‰ ์ „์šฉ์ด๋ฉฐ ๊ธ€ ์ฐพ๊ธฐ์˜ ํ•„ํ„ฐ ๋ณ€๊ฒฝยท์ดˆ๊ธฐํ™”๋กœ ์ง€์šฐ์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ์ „์ฒด ๊ฒ€์ƒ‰ ์ฐฝ์„ ๋‹ซ์•„๋„ ๊ธ€ ์ฐพ๊ธฐ์˜ text ์กฐ๊ฑด์€ ์œ ์ง€๋ฉ๋‹ˆ๋‹ค.

๋ชจ์Œ ์šฉ๋„
๋ฌธ์ œ ํ•ด๊ฒฐ ์‚ฌ๋ก€ ํŠน์ • ์‹œ์ ์˜ ์ฆ์ƒ, ์กฐ์‚ฌ, ๊ทผ๋ณธ ์›์ธ๊ณผ ํ•ด๊ฒฐ ๊ฒฐ๊ณผ๋ฅผ ๋ณด์กดํ•ฉ๋‹ˆ๋‹ค.
์ผ๋ฐ˜ ๊ฐ€์ด๋“œ ํ˜„์žฌ ์žฌ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋Š” ์ ˆ์ฐจ๋ฅผ ์ œํ’ˆ ๋ณ€ํ™”์— ๋”ฐ๋ผ ๊ณ„์† ๊ฒ€์ฆํ•˜๊ณ  ๊ฐฑ์‹ ํ•ฉ๋‹ˆ๋‹ค.
์‹ค์Šต ๋ฐฐํฌ, ์‹คํ–‰, ๊ฒ€์ฆ๊ณผ ์ •๋ฆฌ๋ฅผ ์žฌํ˜„ํ•  ์ˆ˜ ์žˆ๋Š” ์‹œ๋‚˜๋ฆฌ์˜ค์ž…๋‹ˆ๋‹ค.
๋ฆฌ์„œ์น˜ ๋น„๊ต, ๋ฒค์น˜๋งˆํฌ์™€ ์•„ํ‚คํ…์ฒ˜ ์กฐ์‚ฌ๋ฅผ ๊ธฐ์ค€ ์‹œ์ ๊ณผ ํ•จ๊ป˜ ๊ธฐ๋กํ•ฉ๋‹ˆ๋‹ค.

๋ชจ๋“  ์ฃผ์ œ ๋ชฉ๋ก์€ ํŒŒ์ผ๋กœ ์ค‘๋ณต ๊ด€๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ์˜ฌ๋ฐ”๋ฅธ ํด๋”์™€ front matter๋ฅผ ์‚ฌ์šฉํ•˜๋ฉด Pages ๋ฉ”๋‰ด, ์„œ๋น„์Šค ์ƒ‰์ธ๊ณผ ๊ธ€ ์ฐพ๊ธฐ์— ์ž๋™์œผ๋กœ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค. ๊ธฐ์กด /tags/, /articles/ ๋ฐ ์ด์ „ ํƒœ๊ทธ ์ฃผ์†Œ๋Š” ๊ฒ€์ƒ‰ยท๋ฉ”๋‰ด์—์„œ ์ œ์™ธ๋œ ๊ธ€ ์ฐพ๊ธฐ redirect๋กœ ์œ ์ง€ํ•ฉ๋‹ˆ๋‹ค.

๊ณต๊ฐœ ๋ฌธ์„œ์˜ canonical ์›๋ณธ์€ docs/services/<service>/<topic>[/<child>]/index.md topic package์ž…๋‹ˆ๋‹ค. ์‹คํ–‰ ์ฝ”๋“œ์™€ ๊ฒฐ๊ณผ๋ฌผ์€ ํ•ด๋‹น topic์˜ samples/<sample>/์— ๋‘๋ฉฐ, ์ตœ์ƒ์œ„ collection ํด๋”๋‚˜ samples/์—๋Š” ์ƒˆ ๊ณต๊ฐœ ์ฝ˜ํ…์ธ ๋ฅผ ์ถ”๊ฐ€ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.

๋กœ์ปฌ ๋ฏธ๋ฆฌ๋ณด๊ธฐ

python -m venv .venv
.\.venv\Scripts\python -m pip install -r requirements-docs.txt
.\.venv\Scripts\mkdocs serve

์ž์„ธํ•œ ์ž‘์„ฑยท๊ฒ€์ฆ ๊ทœ์น™์€ ๊ณต๊ฐœ ๋ฌธ์„œ ์ž‘์„ฑ ๊ณ„์•ฝ์„ ํ™•์ธํ•˜์„ธ์š”. ๊ฒ€์ƒ‰ ์ธ๋ฑ์Šค ๊ฒ€์ฆ ๋‹ค์Œ์—๋Š” python scripts/docs/audit_pre_pages.py๋ฅผ ์‹คํ–‰ํ•˜๋ฉฐ, ์ด ๊ฐ์‚ฌ๋Š” ์ „์ฒด Git ์ด๋ ฅ์ด ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค. ์ž์„ธํ•œ ๊ธฐ์ค€๊ณผ ์‹คํ–‰ ์ง€์นจ๋„ ๊ณต๊ฐœ ๋ฌธ์„œ ์ž‘์„ฑ ๊ณ„์•ฝ์—์„œ ํ™•์ธํ•˜์„ธ์š”.

์ด ์ €์žฅ์†Œ์™€ Pages๋Š” ๊ณต๊ฐœ๋˜์–ด ์žˆ์Šต๋‹ˆ๋‹ค. ๊ณ ๊ฐยท์‚ฌ์šฉ์ž ์‹๋ณ„์ž, ๊ตฌ๋…ยทํ…Œ๋„ŒํŠธ ID, ๋น„๋ฐ€, ๋‚ด๋ถ€ URL ๋˜๋Š” ์Šน์ธ๋˜์ง€ ์•Š์€ ํ™”๋ฉด ์บก์ฒ˜๋ฅผ ์ปค๋ฐ‹ํ•˜์ง€ ๋งˆ์„ธ์š”.