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

[Publishing] Github Pages #11

Open
code3z opened this issue May 20, 2021 · 13 comments
Open

[Publishing] Github Pages #11

code3z opened this issue May 20, 2021 · 13 comments
Labels
meta About this project itself

Comments

@code3z
Copy link
Contributor

code3z commented May 20, 2021

Should we have a github pages for this guide? Other than looking nice, it would also make it easily searchable and navigatable.

@ghost
Copy link

ghost commented May 21, 2021

I was also thinking about this, but I was unsure about whether it can be done w/o doing the changes on two branches 🤷

@ghost ghost added the meta About this project itself label May 21, 2021
@code3z
Copy link
Contributor Author

code3z commented May 21, 2021

I’m not sure what you mean.

@code3z
Copy link
Contributor Author

code3z commented May 21, 2021

The pages would be to publish it, not edit.

@ghost
Copy link

ghost commented May 21, 2021

Yeah, but I’m not sure if it can be done without either polluting all the files on this branch or creating an extra branch (which would then have to be updated separately). The worse it gets if you want full-site searching and whatnot (if it can be done at all).

@code3z
Copy link
Contributor Author

code3z commented May 21, 2021

Ok

@ghost ghost mentioned this issue May 26, 2021
@code3z
Copy link
Contributor Author

code3z commented May 26, 2021

https://docsify.js.org/#/

I could set this up once we have 6 or so pages.

@code3z code3z changed the title Github Pages tag:publishing [Publishing] Github Pages May 26, 2021
@code3z
Copy link
Contributor Author

code3z commented May 26, 2021

creating an extra branch (which would then have to be updated separately)

But, github branches can be updated in two clicks. And we only need to update it when files are ready for release. Or, if we only merge into master when files are ready to be published, we probably don't need to create another branch. I don't think it would get too polluted, but we'll see.

@code3z
Copy link
Contributor Author

code3z commented May 26, 2021

Would you want to host the webpages on js.org, github.io, or another place?

@ghost
Copy link

ghost commented May 27, 2021

Would you want to host the webpages on js.org, github.io, or another place

If anything, I’d choose the ‘usual’ place, that is tiosgz.github.io/modding-vivaldi

@code3z
Copy link
Contributor Author

code3z commented May 30, 2021

Assign Me

@code3z
Copy link
Contributor Author

code3z commented Jun 3, 2021

I'm thinking not use NPM to avoid polluting master.
Most of the docsify plugins don't seem to have an NPM package anyways.

Would you want to have templates (like wikipedia), like {{ work-in-progress }} or {{ outdated }}?

@ghost
Copy link

ghost commented Jun 4, 2021

I don’t care about adding a single file or folder. What I don’t want is to add something into every single file.

@code3z
Copy link
Contributor Author

code3z commented Jun 4, 2021

Not sure which you are commenting on.

If you are talking about NPM: nothing would need to be added to existing files, but NPM would add multiple files and folders with little benefit.

If you are talking about templates: they only need to be added when it makes sense. For instance, External Resources would get a work-in-progress. It would look fine in plaintext, but on the website it would render into a nice little box encouraging the user to comment on the file or edit the file.

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

No branches or pull requests

1 participant