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

Why is my content not showing up on the Devhub? #1287

Closed
patricksimonian opened this issue Feb 20, 2020 · 1 comment
Closed

Why is my content not showing up on the Devhub? #1287

patricksimonian opened this issue Feb 20, 2020 · 1 comment
Labels
type: discussion This issue is more about a discussion and not entirely requireing a PR

Comments

@patricksimonian
Copy link
Contributor

patricksimonian commented Feb 20, 2020

this issue is not a REAL issue but a stub one. It describes a common bug that can happen to content contributors and how to resolve it

Describe the bug
I have introduced a new markdown file called 'README.md' and have made a pull request. The pull request has been merged but I cannot find my content anywhere.

To Reproduce
Steps to reproduce the behavior:

  1. Go to https://developer.gov.bc.ca/readme

Expected behavior
My content shows up

@patricksimonian
Copy link
Contributor Author

patricksimonian commented Feb 20, 2020

The Devhub has automated validations to ensure the app builds smoothly. One of these validations is to verify the validity of a markdown files title.

The title can be passed in one of two ways. Either as frontmatter or it is automatically inferred by the first # or ## in the document.

The validation of the title is important because this is how the url for that document is generated.

There are two main validations we do:

  1. Check to see if your title conflicts with other titles in the website. For example if two documents had the title 'Agile Fundamentals'. Neither of them will show up on the Devhub since it'd be hard to decide which one should showup.

  2. Check to see if the title is in our blacklist of titles. The blacklist of invalid titles that we do not allow on the site. Mostly because the names are too generic to be used in the context of the Devhub. Titles like 'About', 'Readme' are great in one repository but because of the Devhub sources from many repos_ it doesn't make sense to use them there. In addition, we blacklist titles that conflict with certain prebuilt pages in the Devhub such as 'journeys', 'topics' etc.

What You Should Do

Change the title to your document :) If you are introducing new content, the automated validation check should pass at this stage. If your content already exists, it will reappear on the next build of the devhub.

@patricksimonian patricksimonian added the type: discussion This issue is more about a discussion and not entirely requireing a PR label Feb 20, 2020
@patricksimonian patricksimonian pinned this issue Feb 20, 2020
@bcgov bcgov locked as resolved and limited conversation to collaborators Feb 20, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: discussion This issue is more about a discussion and not entirely requireing a PR
Projects
None yet
Development

No branches or pull requests

1 participant