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

Remove $sitename from (rendered content in) help seeds #38

Open
cellio opened this issue Aug 5, 2021 · 0 comments
Open

Remove $sitename from (rendered content in) help seeds #38

cellio opened this issue Aug 5, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@cellio
Copy link
Member

cellio commented Aug 5, 2021

We seed certain help topics (how to ask, FAQ, not sure if there are others) with text that includes "$sitename". We don't auto-replace that with the actual name, which means we have to edit those topics when we launch new communities.

I propose that we make the help seeds usable in their initial states, so mods can enhance them but don't have to. Replacing "$sitename" with "this site" or just dropping it in some places can work. I just edited the how-to-ask page on some communities to remove two name references that could be generalized, as a workaround to a bug. We could still include HTML comments to indicate places mods might want to edit/enhance and we could use "$sitename" in those comments to give mods something to search for.

Can we make our help seeds work out of the box without making them too vague to be useful?

@cellio cellio added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant