Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Spec-Authoring] Section on remote editing #428

Merged
merged 3 commits into from
Sep 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,13 @@
"*.bs.md": "bikeshed",
"*.inc.md": "markdown"
},
"cSpell.enabled": false,
"cSpell.enabled": true,
"cSpell.words": [
"advisements",
"biblio",
"bikeshed",
"Codespaces",
"dashif",
"plantuml"
],
}
17 changes: 17 additions & 0 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks": [
{
"label": "Build All",
"type": "shell",
"command": "./build.sh",
"problemMatcher": [],
"group": {
"kind": "build",
"isDefault": true
}
}
]
}
32 changes: 30 additions & 2 deletions specs/authoring/authoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ documents. Below is an overview of the tools we use:
and relationships through a variety of diagram types, such as flowcharts,
sequence diagrams, and class diagrams. The integration of Mermaid enhances
the readability and comprehension of our documentation, making intricate
concepts more accessible to our audience. Mermaid is also supported by GitHub markdown rendering directly.
concepts more accessible to our audience. Mermaid is also supported by GitHub
markdown rendering directly.
* [PlantUML](https://plantuml.com/) is another tool that will be part of the
stack and allow us to create visualizations.

Expand Down Expand Up @@ -56,7 +57,7 @@ your edits locally is to:
* `build.bat` on Windows

You might notice that the first build run will take a moment since the
respective container needs to be dowloaded. Subsequent runs will be faster after
respective container needs to be downloaded. Subsequent runs will be faster after
that initial bootstrap.

With the above command, _all_ the documents will be generated and you find the
Expand All @@ -74,6 +75,33 @@ commands. For example for `authoring`:
browser page and you will see the updated version. This process will keep on\
running until you terminate it with `Ctrl-C`.

# Remote Editing Setup # {#remote-editing}

To quickly edit text in a GitHub repository, you can use the [github.dev](https://docs.github.com/en/codespacesthe-githubdev-web-based-editor)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

browser-based editor. Simply press `.` while viewing the repository to open the
editor in your browser. This will launch a lightweight version of VSCode where
you can edit files, create branches, commit changes, and open pull requests
directly from the browser.

However, note that this method doesn’t allow you to preview rendered HTML since
the environment doesn’t support running builds.

If you need to edit documents and preview them, you can use GitHub Codespaces,
which provides a full development environment in the cloud. While not entirely
free, GitHub offers a monthly quota of free minutes for Codespaces usage.

Once your Codespaces is set up, you can run the build using the `build.sh`
script located in the root folder. To preview the generated HTML, install the
"Live Preview" extension by Microsoft. After running the build, expand the
`dist` folder, right-click on one of the generated HTML files, and select
"Show Preview." This will launch an internal server and allow you to view the
results in a browser window.

The key advantage of using Codespaces is that it simulates a local development
environment without needing to install any tools on your machine. However, be
mindful that Codespaces usage may incur costs after your free minutes are
exhausted, and it requires working within VSCode.

# Creating and Editing a Document # {#editing}

As described in [[#structure]], you will find individual documents in folders
Expand Down