upstreamable / docker-wordpress

基于WordPress官方镜像的Docker镜像。

8106.0.0 2022-07-03 21:33 UTC

This package is not auto-updated.

Last update: 2024-09-24 07:27:35 UTC


README

WordPress的Docker镜像

入门指南

为了方便您在GitLab中开始,以下是一些推荐的下一步操作。

已经是专家?只需编辑此README.md文件,使其成为您自己的。想要更简单?使用下面的模板

添加您的文件

cd existing_repo
git remote add origin https://gitlab.com/upstreamable/docker-wordpress.git
git branch -M main
git push -uf origin main

与您的工具集成

与您的团队协作

测试和部署

使用GitLab内置的持续集成。

编辑此README

准备好使此README成为您自己的,只需编辑此文件并使用下面的便捷模板(或者您可以根据需要自由地组织结构,这只是个起点!)感谢makeareadme.com 提供此模板。

良好的README建议

每个项目都不同,请考虑哪些部分适用于您的项目。模板中使用的部分是大多数开源项目的建议。此外,请注意,虽然README可能过长且详细,但过长总比过短好。如果您认为您的README过长,请考虑利用其他形式的文档,而不是删除信息。

名称

为您的项目选择一个易于解释的名称。

描述

让人们了解您的项目具体能做什么。提供上下文,并添加指向可能不熟悉的参考资料的链接。也可以在此处添加功能列表或背景子部分。如果您的项目有替代方案,这是列出区分因素的好地方。

徽章

在某些README中,您可能会看到一些小图像,传达元数据,例如项目是否所有测试都通过。您可以使用Shields在README中添加一些。许多服务也有添加徽章的说明。

视觉

根据您正在制作的内容,包括截图甚至视频(您通常会看到GIF而不是实际视频)可能是个好主意。像ttygif这样的工具可以帮助,但请查看Asciinema以获得更复杂的方法。

安装

在特定的生态系统内,可能存在一种常见的安装方法,例如使用Yarn、NuGet或Homebrew。但是,请考虑阅读您的README的人可能是个新手,并且希望得到更多指导。列出具体的步骤有助于消除歧义,并尽快让人们使用您的项目。如果它只在特定的环境中运行(例如特定的编程语言版本或操作系统)或需要手动安装的依赖项,请添加一个“要求”子部分。

使用

广泛使用示例,并在可能的情况下显示预期输出。如果您能展示最小的使用示例,并提供链接到更复杂的示例(如果它们太长而无法合理地包含在README中),这会有所帮助。

支持

告诉人们他们可以到哪里寻求帮助。它可以是任何组合的问题跟踪器、聊天室、电子邮件地址等。

路线图

如果您对未来发布有任何想法,请在README中列出它们。

贡献

声明您是否欢迎贡献以及接受贡献的要求。

对于想要更改您项目的人来说,有一些关于如何开始的文档可能是有帮助的。也许他们应该运行一个脚本或设置一些环境变量。明确这些步骤。这些说明也可能对您的未来自己有用。

您还可以记录用于检查代码或运行测试的命令。这些步骤有助于确保高代码质量并减少更改意外破坏东西的可能性。如果它需要外部设置,例如启动Selenium服务器以在浏览器中进行测试,那么运行测试的说明特别有帮助。

作者和致谢

向为项目做出贡献的人表示感谢。

许可

对于开源项目,说明其许可方式。

项目状态

如果您对您的项目已经耗尽精力或时间,请在README的顶部注明开发已放缓或完全停止。有人可能会选择分支您的项目或志愿成为维护者或所有者,从而使您的项目能够继续进行。您还可以明确提出对维护者的请求。