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.

Sign up for GitHub

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

Jump to bottom

Decide on a way to publish our engineering docs site on PR #3320

Open
johncowen opened this issue Dec 18, 2024 · 1 comment
Open

Decide on a way to publish our engineering docs site on PR #3320

johncowen opened this issue Dec 18, 2024 · 1 comment
Labels
kind/feature New feature triage/accepted The issue was reviewed and is complete enough to start working on it

Comments

@johncowen
Copy link
Contributor

johncowen commented Dec 18, 2024 •
edited by lahabana
Loading

Description

We have a tonne of engineering information in our repository, that will only grow with time. At the moment you can view this with make run/docs or just using GH to view the markdown it uses.

The thing is the make run/docs approach is just nicer and less problematic, and we can also provide friendly navigation for people to help find things. We should publish this on PR preview so it's easily available to folks how might not have the repo cloned/to hand to run it locally.

Either:

  1. Have a completely separate Netlify site
  2. Publish it as part of our GUI but only in PR preview mode (not production) (in /docs next to /gui)
  3. ...any other ideas.

2 seems to give the biggest bang for buck
@johncowen johncowen added triage/pending This issue will be looked at on the next triage meeting kind/feature New feature labels Dec 18, 2024
@johncowen johncowen mentioned this issue Dec 18, 2024
Merged
@johncowen johncowen changed the title Decide on a way to publish our docs site on PR Decide on a way to publish our engineering docs site on PR Dec 18, 2024
johncowen added a commit that referenced this issue Dec 18, 2024
@johncowen
chore(docs): add name of mock disabling env var (#3319)

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode
Loading
Loading status checks…
ad068a3 
Adds name of mock disabling env var/cookie to our docs so it remains
visible/usable outside of our docs site (ie. in GH markdown)
I also made #3320

Signed-off-by: John Cowen <john.cowen@konghq.com>
@lahabana lahabana added triage/accepted The issue was reviewed and is complete enough to start working on it and removed triage/pending This issue will be looked at on the next triage meeting labels Dec 23, 2024
@github-actions github-actions bot added the triage/stale Inactive for some time. It will be triaged again label Mar 24, 2025
@github-actions GitHub Actions
Copy link
Contributor

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed.
If you think this issue is still relevant, please comment on it or attend the next triage meeting.

@lukidzi lukidzi removed the triage/stale Inactive for some time. It will be triaged again label Mar 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind/feature New feature triage/accepted The issue was reviewed and is complete enough to start working on it
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@johncowen @lahabana @lukidzi