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

Ensure Reference content for Serving and Eventing is up-to-date and viewable #3673

Closed
1 of 2 tasks
omerbensaadon opened this issue May 26, 2021 · 1 comment · Fixed by #3832
Closed
1 of 2 tasks

Ensure Reference content for Serving and Eventing is up-to-date and viewable #3673

omerbensaadon opened this issue May 26, 2021 · 1 comment · Fixed by #3832
Assignees
Labels

Comments

@omerbensaadon
Copy link

omerbensaadon commented May 26, 2021

Description:

Reference content is auto-generated from the serving and eventing repos and gets spit out into https://dev-knative.netlify.app/development/reference/api/serving/ and https://dev-knative.netlify.app/development/reference/api/eventing/eventing/ (a link we certainly want to fix.)

In the past, those releasing docs had to generate this content before cutting a release. @julz has created a script which pulls from serving, but hasn't yet done the same for eventing or displayed it in the links above.


Story

As Ursula the Advanced User
I want to see the most up-to-date reference content for Knative Serving and Eventing
So that I have confidence in what fields are available to me in my Knative deployment 

Acceptance Criteria

Serving and Eventing Generate .md file on each commit

GIVEN there is a new commit in either the /serving or /eventing repo 
WHEN the commit is built by Netlify
THEN the relevant Reference content is compiled into a .md file called "{repo-name}-api.md" 
AND I can find this file in the main {repo-name}/docs folder

.md file is referenced from the correct page in docs

GIVEN Netlify has generated a new "{repo-name}-api.md" file
WHEN I go to the Reference page for either Serving or Eventing
THEN I see the updates made to the "{repo-name}-api.md" on the webpage
AND WHEN I check the file on GitHub 
THEN I see it is leveraging a content-reuse plugin which is "including" the file from the correct repo

Correct Link

GIVEN I visit https://dev-knative.netlify.app/development/reference/api/eventing/
WHEN the page loads
THEN it does not return a 404
AND GIVEN I visit https://dev-knative.netlify.app/development/reference/api/eventing/eventing
WHEN the page loads
THEN it returns a 404 

Known Issues and Considerations:

Who should probably pick up this issue?

  • Existing Contributors
  • New Contributors
@omerbensaadon
Copy link
Author

/assign @julz

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants