Add README.md with basic documentation for qtile.org

[unsungNovelty]

@tych0 - I have added a README.md with basic documentation to get the site up and running. Let me know if any changes are necessary

[unsungNovelty]

Does this mean we have more generated code committed in the themes/qtail directory?

@tych0 - I didn't understand the question exactly. But there is a clear separation of code and content. themes/qtail has all the code logic and styling that powers the site. With contents like md files and images etc being in the parent /qtile.org directory. This is the documentation I was talking about explaining all this. I haven't had the time to work on it this week. But I intend to start this weekend.

Can you delete that and add build steps to the github action to regenerate it?

Let me dig through github actions and figure out how to do that.

Can you put this screenshot in this repo? Or alternatively just drop it, I don't know that it adds much here.

Yes. I will delete it. The screenshot was intended at new programmers who will be confused about change directory commands like cd /qtile.org/themes/qtail.

[tych0]

I didn't understand the question exactly. But there is a clear separation of code and content. themes/qtail has all the code logic and styling that powers the site.

I mean the node_modules directory is generated based on package.json, so we don't need to commit it. See 8e67ca4e590e31fda37423f5994866d3b865fb5d, but I think we can drop this as well and put a npm install in the makefile.

[unsungNovelty]

See https://github.com/qtile/qtile.org/commit/8e67ca4e590e31fda37423f5994866d3b865fb5d, but I think we can drop this as well and put a npm install in the makefile

@tych0 - Hmmm. I am not sure Github actions. So I might be wrong here. But why have you added /public and /resources directories to .gitignore?

/public contains THE website output which is needed to host the website. And resources contains the images that is needed for thumbnails of screenshots. I think there are duplicates in those thumbnails which should be removed. But not sure the entire directory should be ignored. Am I wrong here?

[tych0]

Yes, we do not want to commit the generated code to the repository, since it will just add bloat years down the line when we have generated lots of different versions of it.

Instead, I set it up to push the output of the website (i.e. exactly these public and resource directories) to a separate qtile.github.io, which we can delete/refresh at will when it gets too big (if anyone bothers to clone it at all).

I didn't realize at the time that there was a node_modules directory that was also autogenerated. But I don't think we should do that either.

I think a good patch would be: delete the node_modules directory, and add whatever the necessary npm install actions are to re-create it during the github actions run.

[unsungNovelty]

@tych0 - I misunderstood your question earlier. The only generated file inside /themes/qtail directory is the style.css. I have added the file to .gitignore and have tried to make the changes necessary in the makefile. I am new to makefile, so can you please have a look at it?

[unsungNovelty]

@tych0 - Can you please have a look and see if this looks OK? Excuse multiple commits. First time using github actions and yaml file. Had to rely on my spidey senses to figure it out.

[tych0]

The github ci stuff looks good, but the other comments I made still need to be fixed it looks like. I can squash the series once that's all done, or you can.

[unsungNovelty]

@tych0 - I have removed the screenshot from readme.md and have made the changes to Makefile. Did I miss anything?

[tych0]

Hm, I don't understand what I did exactly to close this, but now I've pushed these to master and it looks like we've had a successful deploy: https://github.com/qtile/qtile.org/actions

Thanks!

[unsungNovelty]

@tych0 - Great! Was waiting for this to be merged. I will start working on the rest of the changes soon.