Technical writing и Azure Static Web Apps - techtalk proposal

A Collection of Interesting Ideas,

This version:
https://ungerfall.github.io/2021/06/27/technical-writing-and-azure-static-web-apps.html
Editor:
(EPAM Systems)

Abstract

Документ содержит предложение проведения технического доклада на тему "Technical writing и Azure Static Web Apps"

1. Вступление

Every engineer is also a writer.
Рассмотрим недавно открывшиеся курсы Technical Writing от Google
Azure Static Web Apps - сервис, автоматически строящий и разварачиващий web приложения из исходного кода.
Расмотрим основные возможности и продемонстрируем работу связки Github Pages + Jekyll + serverless Azure Functions

2. Мотивация

Призвать коллег к написанию технической документации или технического блога.
На текущий момент в Comminity Z нет ни одного доклада по ключевым словам Azure Static Web Apps, Github Pages, Technical Writing

3. Кому будет интересна тема

Всем разработчикам.

4. Состав доклада

Будет состоять из 3 частей общей длительностью 45 минут

4.1. Tech writing от Google. 15 минут

Покажу состав курса от Google на слайдах и сам курс в браузере.

4.2. Azure Static Web Apps 15 минут

В этой части рассмотрим сервис, фичи, стоимость.

4.3. Демо. Github Pages and Azure Static Web Apps. 15 минут

Создадим страницу Github Pages с помощью генератора Jekyll. Опубликуем в Azure Static Web Apps и покажу пример работы вместе с Azure Functions.

4.4. Q&A.

Q&A сессия.

5. Что осталось сделать

  1. Презентация

6. Когда

14 июля. Или любой другой день этой недели

7. Предложения

Открыт к предложениям к улучшению.

Conformance

Conformance requirements are expressed with a combination of descriptive assertions and RFC 2119 terminology. The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in the normative parts of this document are to be interpreted as described in RFC 2119. However, for readability, these words do not appear in all uppercase letters in this specification.

All of the text of this specification is normative except sections explicitly marked as non-normative, examples, and notes. [RFC2119]

Examples in this specification are introduced with the words “for example” or are set apart from the normative text with class="example", like this:

This is an example of an informative example.

Informative notes begin with the word “Note” and are set apart from the normative text with class="note", like this:

Note, this is an informative note.

References

Normative References

[RFC2119]
S. Bradner. Key words for use in RFCs to Indicate Requirement Levels. March 1997. Best Current Practice. URL: https://tools.ietf.org/html/rfc2119