Commit graph

26 commits

Author SHA1 Message Date
nodiscc
dd8a69552a
doc: fix link to liberapay page 2024-04-09 00:14:50 +02:00
nodiscc
c4b925e5da
doc: add liberapay badge alongside other badges (#652)
- ref. https://github.com/awesome-selfhosted/awesome-selfhosted-data/pull/73
2024-04-08 17:08:39 +00:00
nodiscc
4dca181892
doc: mention both HTML and markdown versions in the README (#64) 2023-08-22 13:15:02 +00:00
nodiscc
b23d099360
doc: remove experimental status notice (#55)
- fixes https://github.com/awesome-selfhosted/awesome-selfhosted-data/issues/11
2023-08-22 13:13:23 +00:00
nodiscc
11520bd624
tools/github actions: split dead links/unmaintained projects check workflow to separate workflows
- generate 2 separate badges and use them in the project README, CONTRIBUTING, output markdown files
- fixes https://github.com/awesome-selfhosted/awesome-selfhosted-data/issues/49
2023-07-28 14:17:50 +02:00
nodiscc
197d9cd7a7
doc: move contribution guidelines to CONTRIBUTING.md (#44)
- fixes https://github.com/awesome-selfhosted/awesome-selfhosted-data/issues/40
- doc: ISSUE_TEMPLATE/other.md: cleanup
- doc: .github/PULL_REQUEST_TEMPLATE.md: fix link to addition template
- doc: LICENSE: fix license file header/auomatic license detection by Github
- doc: license: add link to summary of license terms
- doc: group authors and licenses sections
2023-07-26 19:50:16 +00:00
nodiscc
6ea9e4507f
finalize automation/CI workflows:
- build markdown/HTML versions, use separate makefile targets/hecat configuration files for each export format/push task
- add non-free.md generation step to markdown export hecat configuration file
- add makefile targets to push exports to https://github.com/awesome-selfhosted/awesome-selfhosted and https://github.com/nodiscc/awesome-selfhosted-html-preview
- install: install sphinx <7 directly using pip since it can't be installed from setup.py https://github.com/sphinx-doc/sphinx/issues/11130
- pin sphinx to version <7, sphinx-design is not compatible with sphinx 7 https://github.com/executablebooks/sphinx-design/issues/130
- add sphinx configuration file
- tools/makefile: monkeypatch furo theme to display build tools and license link in footer (furo/sphinx does not provide a way to customize this https://github.com/pradyunsg/furo/discussions/612)
- fix dependencies between makefile targets
- setup/document SSH deploy keys usage
- each repository requires a different deploy key, trying to add a deploy key to repo B, which has already been added to repo A results in error 'this key already exists'
- set git remote URL to use ssh URIs before push (required to use SSH deploy keys)
- when referencing an environment secret, environment: key must be defined explicitly for the step (https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#referencing-an-environment)
- use a single SSH key file/no ssh-agent, else git push will try to use the first registered key and fail with permission denied when trying to push to the HTML repository
- use variables to identify target repos
- use temporary repositories as push destination
2023-07-24 16:10:43 +02:00
nodiscc
294d940953
doc: fix link to daily-update-metadata workflow logs 2023-07-22 19:14:42 +02:00
nodiscc
4387d6e79b
README.md: update CI badges to reflect new workflows 2023-07-22 19:11:13 +02:00
nodiscc
4e4e656b2c
tools/makefile: add make clean target 2023-07-22 11:13:58 +02:00
nodiscc
646014387f
doc: clarify tags/license formatting 2023-07-17 14:14:53 +02:00
nodiscc
2322f5ce55
tools/makefile: add make authors target (update AUTHORS file)
- update documentation
2023-07-16 17:49:15 +02:00
nodiscc
a29a0dbdf7
doc: improve description of required/optional fields in license/platform/tag files (#29) 2023-07-11 12:22:15 +00:00
nodiscc
26652fcb9b
doc: readme: reordering/formatting 2023-04-15 14:36:52 +02:00
nodiscc
67e50eace3
doc: update README.md/remove unused delegate_to example 2022-11-05 12:38:17 +01:00
nodiscc
17a68e60c9
doc: update issue template/formatting, deduplicate information 2022-08-10 18:47:29 +02:00
nodiscc
dae52f8519
doc: update makefile help text 2022-08-10 16:07:36 +02:00
nodiscc
786f65fb10
doc: make source_code_url key mandatory 2022-08-07 21:17:30 +02:00
nodiscc
9ceff67a58
doc: README: fix typo/checkbox syntax 2022-06-05 19:57:26 +02:00
nodiscc
613777928b
tools/doc: makefile: (auto-)document makefile targets with 'make help' 2022-06-05 17:55:23 +02:00
nodiscc
5cb8afa849
README.md: add a note about project status/experimental
- https://github.com/awesome-selfhosted/awesome-selfhosted-data/issues/11
2022-06-04 15:55:03 +02:00
nodiscc
27532d4ace
README.md: clarify software addition procedure 2022-06-04 15:24:51 +02:00
nodiscc
d5e1891b17
README.md: fix new file creation link 2022-06-04 15:14:27 +02:00
nodiscc
9e0b0dec71 add basic markdown list build process
- rebuild markdown README.md and check for differences against the original
- add build steps to makefile so it can be run locally
- call make from Github actions so it runs automatically on commits/pull requests
2022-04-29 15:58:53 +02:00
nodiscc
80474a9598 add README.md (contribution process) 2022-04-29 15:45:18 +02:00
nodiscc
2551c10eb0
add README.md (initial commit) 2021-06-27 17:10:54 +02:00