Skip to content

docs: reorganize template docs #10297

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

Merged
merged 41 commits into from
Oct 17, 2023
Merged

docs: reorganize template docs #10297

merged 41 commits into from
Oct 17, 2023

Conversation

matifali
Copy link
Member

@matifali matifali commented Oct 16, 2023

@bpmct, it looks like #9139 was merged to emplates-docs.
This PR merges it to main.

bpmct and others added 6 commits July 28, 2023 04:12
* Reorg, updated/new screenshots, consistent terminology

* First pass

* Another pass

* Added integration section

* New outline for template pages, small updates

* Revised outline for templates, added tutorial

* First pass at tutorial

* Some feedback from Ben.

* Update docs/workspaces.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Update docs/workspaces.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Update docs/workspaces.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Fixed typos

* Expanded tutorial

I have read the CLA Document and I hereby sign the CLA

* New screenshots, improved tutorial, revised anatomy

* Improved tutorial. Anatomy is now a guided tour.

* First pass at guided tour

* Updated authentication info

* Reorganized the guided tour

* Edited more template pages

* Update docs/templates/tour.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Update docs/templates/tour.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Update docs/templates/tour.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Update docs/templates/tutorial.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Update docs/templates/tour.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Update docs/templates/tour.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Update docs/templates/tour.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Update docs/templates/tour.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Update docs/templates/tour.md

Co-authored-by: Muhammad Atif Ali <matifali@live.com>

* Revised devcontainers and docker-in-workspaces

* Edited and added screenshots

* Prepared first draft, except docs/templates/open-in-coder.md

* Fix typo

* remove legacy parameters and migration guide

* Use coder templates create

* Added screenshot for workspace template variables

* Made it prettier

* Fixed minor typos and markdown problems

* edits to repairing workspaces

* fix broken links in product

* Added troubleshooting, minor corrections.

* fix terminal links

* fmt

---------

Co-authored-by: Muhammad Atif Ali <matifali@live.com>
Co-authored-by: Ben Potter <me@bpmct.net>
Co-authored-by: Atif Ali <atif@coder.com>
@matifali matifali requested a review from bpmct October 16, 2023 20:54
@matifali
Copy link
Member Author

Hi @matifali and @ericpaulsen, as this is a major refactor, I would like you to review if we have accidentally removed some docs. The old PR #9139 was based on a very old branch, so I had to make some decisions on what to keep.

@matifali
Copy link
Member Author

@bpmct I have also checked the docs preview on coder.com and they look fine.

@marcpaq
Copy link
Contributor

marcpaq commented Oct 17, 2023

@matifali I've taken a look at the content changes in docs, in the PR and in the dev.coder.com docs preview. Except for my comments above, it looks good to me.

I've also quickly reviewed the links in site/src/pages/*/*.tsx, which seem appropriate (but I'm not an expert on this code).

Nice merge. Thanks!

Copy link
Member Author

Thanks, I have addressed all your comments.

Copy link
Member

@bpmct bpmct left a comment

Choose a reason for hiding this comment

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

LGTM as long as you tested w/ the docs preview

@matifali matifali enabled auto-merge (squash) October 17, 2023 14:35
@matifali matifali disabled auto-merge October 17, 2023 14:36
@matifali
Copy link
Member Author

links check pass: https://github.com/coder/coder/actions/runs/6548788879/job/17784246419
manually tested docs

@matifali matifali enabled auto-merge (squash) October 17, 2023 14:41
@matifali matifali merged commit a49e6b8 into main Oct 17, 2023
@matifali matifali deleted the templates-docs branch October 17, 2023 14:47
@github-actions github-actions bot locked and limited conversation to collaborators Oct 17, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants